SCHEMAXIS · Declared work. Results you can check.Documentation ↗ · Contact
schemaxis/Agent’s Hands

Documentation / paraview-operation-reference.md
Core 11629ae · View or edit Markdown on GitHub ↗

ParaView adaptor: complete operation reference

Generated from the current installed declarations and conceptual guidance on 2026-10-10. Regenerate with PYTHONPATH=src python3 tools/generate_paraview_guide.py from the repository root.

645 operation identifiers. This lists every registered input, option (including nested proxy choices), declared command, output kind and coverage gap. Native selection descriptions retain their provenance in native-context.json; the ParaView copyright notice applies.

Guide · Shared dollar syntax

Examples are syntax templates, not native acceptance fixtures. Replace placeholder strings, upstream node IDs and data-dependent settings with appropriate real values. The small values illustrate types only; array domains, scientific intent and native compatibility require planning/inspection/execution. Options without defaults deliberately preserve native initialisation. Each option row supplies an example, including optional keys. Nested proxy examples show selection syntax; their own option tables follow.

Index#

  • append — Combines the meshes of several input nodes (any dataset types, non-composite) into one unstructured grid, ParaView 5.13.3's default output type for Append Datasets. Points are not merged and only point and cell arrays present on every input are kept. Use it to treat parts as one dataset for a filter or export; use appendGeometry for surfaces, group to keep inputs as separate blocks, and merge for the blocks of one composite node.
  • appendGeometry — Appends several polygonal (vtkPolyData) inputs, such as surfaces, lines or point clouds, into one polydata without merging points. Only point and cell arrays common to all inputs survive. Use it to combine surface parts for a joint export or surface filter; use append for mixed dataset types.
  • calculator — Evaluates a ParaView Calculator expression at every point or cell and adds the result as a new array named by result, e.g. velocity magnitude mag(U) or a non-dimensional group. The output is the input dataset type with one more array of the chosen association; existing arrays and geometry are unchanged. Use pvCalculator for coordinate results, other result types or table data.
  • cellSize — Adds cell-data arrays holding the size of each cell: Length for 1-D cells (lines, polylines), Area for 2-D cells (triangles, quads, polygons) and Volume for 3-D cells, all in dataset coordinate units (length, length squared, length cubed). Cells of a dimension that is not computed get 0 in that array. Use it for cell volumes or face areas, e.g. to weight cell values or check mesh resolution; with sum enabled the totals are also stored as field data. pvCellSize exposes the same filter with every native setting, including the vertex count and array names; pvMeshQuality rates cell shape instead of size.
  • cellToPoint — Interpolates cell-centred arrays to mesh points: each point receives the average of the cells that use it, producing point fields for stream tracing, contours and smooth colouring. The mesh is unchanged. Averaging smooths sharp cell-to-cell changes and blurs discontinuities such as shocks or material interfaces. Use pointToCell for the reverse.
  • clean — Cleans polygonal data: merges duplicate points within a tolerance, removes unused points and turns degenerate cells into lower-dimensional ones (a triangle with two merged points becomes a line). Output is polydata. Use it after appendGeometry or on surfaces with duplicated vertices to get a connected surface for normals, curvature, connectivity or decimation. For other dataset types use cleanGrid.
  • cleanGrid — Converts any dataset into an unstructured grid and merges coincident points (exactly coincident at the Schemaxis default tolerance 0), optionally removing points used by no cell (Schemaxis default true). Use it to obtain an unstructured grid for operations that need one, or to stitch appended parts. Use clean when the input is polydata and polydata output is wanted.
  • clip — Cuts the input with a plane through origin with normal normal and keeps one side, returning an unstructured grid of whole and cut cells (dimension is kept, unlike slice). With the Schemaxis default invert false the kept half is the side the normal points into; true keeps the opposite side. Use it to open a volume for viewing interior fields; use pvClip for box, sphere, cylinder or scalar clips and for crinkle (whole-cell) clipping.
  • cone — Creates a polygonal cone surface of given height and base radius. Its centre is the midpoint of the axis, the axis follows direction, and the apex lies on the direction side; resolution sets the number of facets around the axis and capping closes the base. Use it as a marker, glyph or simple test geometry; coordinates are in the units of the data it is shown with.
  • connectivity — Labels the connected regions of the input (cells linked through shared points) and keeps all regions, the largest one (most cells) or the one closest to a point; output is an unstructured grid. With colourRegions (Schemaxis default true) a RegionId array identifies each region. Use it to separate disjoint bodies, drop small fragments or isolate the part near a location.
  • contour — Extracts isosurfaces (3-D input) or isolines (2-D input) where a point-centred scalar field equals each of the given values, and outputs them as polydata; several values give several surfaces in one output. Use it for level sets such as a temperature front or a Q-criterion vortex surface. By Schemaxis default the output carries normals and the contour value as an array, but no gradients. Use pvContour for the full native settings.
  • curvature — Computes per-point curvature of a polygonal surface (Gaussian or mean, the two curvature types ParaView 5.13.3 offers) as a point array such as Mean_Curvature or Gauss_Curvature. Use it to locate ridges, valleys or highly curved regions on CAD or scanned surfaces. Mean curvature is in inverse length units and Gaussian in inverse length squared; both are noisy on coarse or irregular triangulations. The mean-curvature sign assumes outward normals.
  • cylinder — Creates a polygonal cylinder surface of given radius and height, centred on centre with its axis parallel to y, including point normals and texture coordinates. resolution sets the facets around the axis and capping closes both ends. There is no orientation setting: follow it with transform to rotate the cylinder.
  • decimate — Reduces the triangle count of a polygonal surface by a target fraction (Schemaxis default 0.5) with vtkDecimatePro, trying to preserve shape; preserveTopology (Schemaxis default true) prevents holes and splits at the cost of possibly missing the target. Use it to lighten large surfaces for rendering or export. Input must be triangles; run triangulate first if other polygons are present.
  • delaunay2D — Builds a 2-D Delaunay triangulation of the input points (any point set, e.g. a point cloud or the points of a mesh; input cells are ignored) and outputs polydata triangles. Triangulation is done in the x-y plane: z is ignored for connectivity but kept on the points, so it suits height fields and nearly planar sets aligned with x-y. With alpha 0 (Schemaxis default) every triangle of the convex hull is kept; a positive alpha keeps only triangles whose circumcircle radius is at most alpha, carving concave outlines and gaps. Use pvDelaunay2D for a best-fitting plane, and delaunay3D for tetrahedra.
  • delaunay3D — Builds a 3-D Delaunay tetrahedralization of the input points (any point set) and outputs an unstructured grid of tetrahedra filling their convex hull. A positive alpha (Schemaxis default 0) produces an alpha shape: only tetrahedra whose circumsphere radius is at most alpha, plus qualifying triangles, are kept, which recovers concave shapes from point clouds. Use it to mesh scattered 3-D samples for interpolation or volume estimates; use delaunay2D for surface-like sets and pvDelaunay3D to choose which alpha cell types are output.
  • disk — Creates a flat annulus (polydata) centred at the origin in the XY plane, with inner and outer radius and radial and circumferential resolution; set innerRadius to 0 for a full disc. Use it as a seed or probe surface, a marker or test geometry, and place it with transform.
  • edges — Extracts every edge of every cell as a line cell, giving a wireframe polydata of the whole mesh, including interior edges of volume cells. Each shared edge appears once and receives the cell data of the lowest-numbered cell using it. Use it to show or export mesh structure or to measure edge lengths; use featureEdges for only boundary or sharp edges of a surface, and run surface first if only the outer skin's edges are wanted.
  • elevation — Adds a point scalar array named Elevation: each point is projected onto the line from lowPoint to highPoint and the position along that line is mapped linearly onto range, clamped at both ends. Use it to colour by height or depth along any direction, or as a synthetic field for testing. Schemaxis assigns its defaults (z from -1 to 1 mapped to 0 to 1), so set the points to your data's extent.
  • extractBlock — Extracts selected blocks from a composite dataset (multiblock, partitioned dataset collection or AMR), such as the internalMesh or individual patches of an OpenFOAM case read by foam. Blocks are chosen by selectors, path expressions over the input's block hierarchy such as "/Root/internalMesh" or "//inlet". The output keeps the composite type with only the selected blocks (overlapping AMR becomes a partitioned dataset collection). Use merge afterwards when one dataset is needed; pvExtractBlock also exposes the assembly choice.
  • extractSubset — Extracts a volume of interest from structured data (image data, rectilinear or structured grid) by an IJK point-index range, optionally keeping every n-th index. The output keeps the input's structured type, so it stays compact and works with structured filters. Use it to crop a structured block or image by index; use a clip for geometric cuts or unstructured meshes.
  • featureEdges — Extracts edges of a polygonal surface as line cells (polydata): boundary edges (used by one polygon), feature edges (between two polygons whose normals differ by more than angle), non-manifold edges (shared by three or more polygons) and optionally manifold edges. With the Schemaxis defaults (boundary, feature and non-manifold on, manifold off, 30°) it outlines a CAD or CFD surface's creases, open boundaries and T-junctions. Input must be polydata; run surface first on volume meshes. Use edges for every cell edge.
  • foam — Curated OpenFOAM reader: opens a case through its .foam marker file and outputs a multiblock dataset whose blocks are the selected mesh regions (internalMesh volume cells, patch/<name> boundaries) carrying the selected cell fields, with one time step per stored time directory. Schemaxis defaults read a decomposed case (processor* folders), only internalMesh, and keep the 0 directory; other reader settings keep ParaView's defaults, which also create point data interpolated from the cell fields. Use pvOpenFOAMReader for point or Lagrangian fields, zones, label/scalar size or the other native options.
  • generateIds — Adds arrays holding each point's and each cell's index (zero-based ids in the input), so that later clipping, extraction or merging carries the original ids along and results can be traced back to the source mesh. The geometry and type are unchanged and existing arrays are kept; each generated id array becomes that attribute's active scalars. For hyper-tree grids cell ids are always generated, and pointIds, pointName and cellIds have no effect.
  • gradient — Estimates the spatial gradient of a point or cell array and stores it as a new array on the same mesh: 3 components for a scalar, 9 (row-major d(component)/d(x, y, z)) for a 3-component vector. Optionally adds divergence, vorticity and the Q-criterion of a vector field, e.g. for vortex identification. Unstructured meshes use cell derivatives, structured ones central differences. Use pvGradient for the full native settings and other output names.
  • group — Combines several input nodes into one multiblock (composite) dataset, one block per input in connection order, without changing the data. Use it to process, colour or export several parts together while keeping them distinct; use append or merge when you need a single mesh.
  • integrate — Integrates all point and cell arrays over the input's cells and computes the total length, area or volume, producing a one-point unstructured grid with one integrated value per array. Only cells of the highest dimension present are used (a volume mesh ignores its faces) and vertex cells are not integrated. With divideByVolume the cell-data integrals are divided by the total size, giving size-weighted means. Use it for totals such as mass or force and for mean values; results carry the array units times length, area or volume.
  • line — Creates a straight polyline from start to end with resolution intervals (Schemaxis default 20, so 21 points), as a separate polydata source. Connect it to streamTracer.seed to place streamline seeds, or use it as probe geometry; it is not the velocity dataset and carries no fields. To sample fields along a segment use probeLine.
  • merge — Merges every leaf dataset of a composite input (multiblock or partitioned data, e.g. the regions and patches from foam) into one unstructured grid, ParaView's default output type. Use it before operations or exports that need a single non-composite dataset. Point merging (on by Schemaxis default) fuses exactly coincident points at block interfaces so the result is connected. Use pvMergeBlocks for polydata output, a merge tolerance or partition-only merging, and append to combine separate nodes.
  • normals — Computes point normals of a polygonal surface by averaging the normals of adjacent polygons, for smooth shading and for operations that need normals (warping along normals, glyphs). With splitting, points on edges sharper than featureAngle are duplicated so each side keeps its own normal; consistency reorders polygons so neighbours agree. Output is polydata with a Normals point array.
  • outline — Produces the 12 edges of the input's axis-aligned bounding box as polydata lines. Use it as a context frame in scenes or to check a dataset's extent; it carries no field data.
  • passArrays — Keeps only the named point, cell and field arrays of the input and removes every other array of those associations; geometry and topology are unchanged (shallow copy, so it is cheap). Use it to slim a dataset before export or publication, or to drop arrays that would confuse later steps. Each list has the Schemaxis default [], and an empty list keeps none of that association's arrays. Use pvPassArrays when vertex, edge or row (table) arrays also need selecting.
  • plane — Creates a flat parallelogram (polydata) with one corner at origin and edges running to point1 and point2, subdivided into xResolution × yResolution quadrilaterals. Use it as a probe or seed surface, for example for resampling or streamline seeds, or as test geometry. The Schemaxis defaults give a 2 × 2 square in the XY plane centred at the origin, with 10 × 10 cells.
  • pointToCell — Averages point arrays onto cells: each cell receives the unweighted mean of its points' values. The mesh is unchanged; only the array association changes. Use it when a later operation, a threshold or an integration needs cell data, or to compare with cell-centred solver output. Use cellToPoint for the reverse.
  • probeLine — Samples the input's point and cell arrays along the segment from start to end (Plot Over Line), interpolating within cells, and outputs a polyline with the sampled arrays plus arc_length and vtkValidPointMask (1 where a sample lies inside the data). Use it for spatial profiles, e.g. velocity across a channel. ParaView's XML default sampling pattern is uniform, for which resolution (Schemaxis default 100) is the number of intervals.
  • pvADIOS2CoreImageReader — Reads variables from an ADIOS2 BP file or BP4/BP5 directory as arrays on a uniform image (vtkImageData). One variable (Image Dimension) defines the image size; each selected variable becomes a point or cell array according to its shape, and an optional variable supplies the time values. Use it for simulation codes that write plain multi-dimensional arrays through ADIOS2; use pvADIOS2VTXReader when the file embeds a VTK schema and pvFidesReader when it follows a Fides data model.
  • pvADIOS2VTXReader — Reads an ADIOS2 BP file or BP4 directory that embeds a VTK XML schema (VTX), either as a BP attribute or as a vtk.xml subfile, describing image data (vti) or unstructured grid (vtu) content; the output is that dataset, with time steps from the BP steps. It is a distributed reader. Choose it for codes that write VTX-annotated ADIOS2 output (e.g. via the VTX schema), and pvADIOS2CoreImageReader or pvFidesReader for other ADIOS2 layouts.
  • pvAMRConnectivity — Fragment identification on non-overlapping AMR material data (such as CTH output from pvSpyPlotReader): for each selected volume-fraction cell array it labels connected regions of cells whose value exceeds VolumeFractionValue, including across block and level boundaries when ResolveBlocks is on, and adds a cell array RegionId-<array name>. The output is the same AMR data with these labels; pvAMRFragmentIntegration then sums fragment volumes and masses. Use pvAMRFragmentsFilter to run the whole chain in one step.
  • pvAMRContour — AMR Contour (vtkPVAMRDualContour) extracts material interface surfaces from non-overlapping AMR volume-fraction data using the dual grid, so surfaces stay crack-free across refinement levels. For each selected cell array it outputs a block of polygonal surface at VolumeFractionValue (multiplied by 255 internally), optionally capped where the material meets the domain boundary. Use it to visualize material boundaries in CTH-style AMR data; for meshes or image data use contour.
  • pvAMRDualClip — AMR Dual Clip (vtkPVAMRDualClip) clips non-overlapping AMR volume-fraction data with the dual grid and outputs, per selected material array, an unstructured grid of tetrahedra covering the region where the fraction exceeds VolumeFractionValue (multiplied by 255 internally). Level transitions are handled and interior tetrahedra can be decimated to keep the mesh small. Use it to get a volumetric mesh of a material region; use pvAMRContour for its surface only.
  • pvAMRFragmentIntegration — Integrates fragments previously labelled by pvAMRConnectivity: for each material array it reads the RegionId-<array name> cell labels and outputs a table (one block per material in a multiblock) with "Fragment ID", "Fragment Volume", "Fragment Mass" and one "Volume Weighted <name>" or "Mass Weighted <name>" column per selected array. Fragment volume is the volume fraction (0-255 scaled) times cell volume; mass is the sum of the chosen mass array. Use it for size and mass statistics of debris or droplets; pvAMRFragmentsFilter runs connectivity and integration together.
  • pvAMRFragmentsFilter — One-step fragment analysis for non-overlapping AMR material data: it runs AMR connectivity (always resolving fragments across blocks), then fragment integration and optionally surface extraction, with one shared VolumeFractionValue. Output port 0 holds the fragment tables ("Fragment ID", "Fragment Volume", "Fragment Mass" and one "Volume Weighted <name>" or "Mass Weighted <name>" column per selected array) when IntegrateFragments is on; port 1 holds the fragment surfaces when ExtractSurface is on, made watertight by the AMR dual contour if UseWatertightSurface is set or by ExtractCTHPart otherwise. Select a port with {"node": id, "port": n}.
  • pvAMRGaussianPulseSource — Generates a small synthetic overlapping AMR dataset (vtkOverlappingAMR) with two levels: a root block of 6 × 6 (× 6) points starting at (-2, -2, 0) with spacing RootSpacing, plus two refined patches. Cell arrays are "Gaussian-Pulse" = PulseAmplitude · exp(-Σ((x - origin)/width)²) and "Centroid". Use it to test AMR pipelines and readers (compare with pvXMLUniformGridAMRReader); it is not physical data.
  • pvAMReXBoxLibGridReader — Reads AMReX/BoxLib plotfiles (directories named like plt00000) into a hierarchical-box (overlapping AMR) dataset of cell-centred grid variables, levels 0 to Level. Listing several plotfile directories in FileNames makes a time series. Use it for AMReX codes such as Castro, Nyx, MAESTROeX or PeleC; use pvAMReXBoxLibParticlesReader for the particles stored in the same plotfiles.
  • pvAMReXBoxLibParticlesReader — Reads particles stored in AMReX plotfiles, producing point data (polydata blocks) with the selected particle components as point arrays; ParticleType names the particle container subdirectory inside each plotfile (ParaView default "particles"). It is a distributed reader. Several plotfile directories form a time series. Use pvAMReXBoxLibGridReader for the grid variables of the same plotfiles.
  • pvANLHaloFinder — Cosmology halo finder from the HACC CosmoTools library (vtkPANLHaloFinder). Input is an unstructured grid of particles with point arrays vx, vy, vz and id, as read by pvGenericIOReader. It links particles closer than Linkinglength (in units of the mean interparticle spacing) into friends-of-friends halos of at least FOFparticlethreshold particles. Port 0 returns the particles with fof_halo_tag (-1 outside halos), port 1 one point per halo with mass, centre of mass, mean velocity, velocity dispersion and centre, and port 2 subhalos when FindSubhalos is on.
  • pvANLSubhaloFinder — Runs the CosmoTools subhalo finder (vtkPANLSubhaloFinder) on halos already found by pvANLHaloFinder: the input is that filter's port 0 particles with vx, vy, vz, id and fof_halo_tag. Port 0 returns the particles with a subhalo_tag array (-1 outside subhalos) and port 1 one point per subhalo with mass, centre of mass, mean velocity and velocity dispersion. Mode chooses all halos, halos larger than SizeThreshold, or only the halo ids in HalosToProcess.
  • pvAVSUCDReader — Reads AVS Unstructured Cell Data files (.inp, ASCII or binary) into an unstructured grid with optional point (node) and cell arrays. Several files in FileNames form a time series. Use it for meshes and results exported in AVS UCD form by FE or CFD tools.
  • pvAdaptiveCosmoCore — Reads LANL cosmo-format particle data that an adaptive-sampling preprocessor split into resolution levels (vtkACosmoReader, extension .cosmo). The output is a multiblock with one block per level (block 0 empty), each holding particle unstructured grids; Level chooses how many levels to load (1 is the coarsest). Use pvCosmoReader for ordinary single-resolution cosmo or Gadget files.
  • pvAdaptiveResampleToImage — Resamples any dataset onto several image (vtkImageData) blocks, output as a vtkPartitionedDataSet: a k-d tree splits the input points into at least NumberOfImages regions (rounded up to a power of two; 0 means one per MPI process, so one in serial), and each region is sampled with SamplingDimensions points, so densely populated regions get finer spacing. Points outside the input are marked invalid, as with pvResampleToImage. Use it to obtain regular grids of unevenly distributed data for volume rendering or image analysis; use pvResampleToImage for one image over the whole domain.
  • pvAddFieldArrays — Deprecated name (since ParaView 5.13, removal planned for 5.14) of pvFieldArraysFromFile, with the same behaviour: the input passes through and the field-data arrays of a legacy VTK file (.vtk) are attached to it, to every block of a composite input. Use pvFieldArraysFromFile in new documents.
  • pvAggregateDataset — Parallel data-movement filter: gathers the pieces of a distributed dataset onto NumberOfTargetProcesses MPI processes (ParaView default 1), leaving the other processes empty; VTK documents it for polydata and unstructured grids. Use it in MPI runs to reduce the number of pieces before writing or rendering a modest result. In a serial run there is only one process and the data pass through. Input must be a single, non-composite dataset.
  • pvAlignImageOrigins — Gives every image block of a composite (multiblock or partitioned) image dataset the same origin and rewrites each block's extent relative to it, so blocks that are parts of one image share a global index space and extent-based operations such as extractSubset behave consistently across blocks. All images must have the same spacing; the shared origin is the minimum corner of all blocks, shifted so that corner gets index MinimumExtent. Point positions do not change.
  • pvAngularPeriodicFilter — Rebuilds a full rotor or periodic set of sectors from a computed sector: selected blocks are copied and rotated about an axis (X, Y or Z through Center) by multiples of an angle, rotating point coordinates and 3- and 9-component arrays (vectors and tensors) consistently. Each selected leaf becomes a multipiece of rotated copies, the first being the original; with IterationMode Maximum (ParaView default) there are round(360 / angle) copies, otherwise NumberOfPeriods. The angle is RotationAngle in degrees (default 10) or read in radians from a field array. VTK supports polydata, structured and unstructured grid leaves.
  • pvAnimateModes — Turns modal-analysis results, where each 'time step' of the input (e.g. Exodus) is really a mode shape, into a vibration animation: ModeShape (1-based) picks the mode, and the points are displaced by DisplacementMagnitude × cos(2π t) × the displacement vectors, with t the requested time in [0, 1]. Output keeps the input structure, has no discrete time steps and adds mode_shape field arrays. Use pvWarpByVector for a single static displacement.
  • pvAnnotateAttributeData — Produces a one-cell text table showing Prefix followed by one value of an array: element ElementId of the chosen point, cell, field or row array, taken from MPI rank ProcessId. Use it to label an image with a probe value or a global quantity such as a residual. Input must be a non-composite dataset or a table; ParaView needs its Python support for this filter.
  • pvAnnotateGlobalData — Turns one value of a field-data (global) array into a text table: Prefix, the value formatted with Format, then Suffix, e.g. "Value is: 1.234e+05". If the array has one entry per time step it is indexed by the current time step, so the text follows the animation. The output is a one-row text table for display as an annotation, not a dataset to process further.
  • pvAnnotateSelection — Adds a string array named "Annotate Selection" to the points or cells of Input, labelling each element selected by node i of the Selection with Labels[i] and every other element with DefaultLabel. Use it to tag regions (e.g. inlet, outlet) for colouring or export. The output is the input dataset with the extra array.
  • pvAnnotateTime — Source (no input) that produces a one-cell table whose Text column holds the requested animation time formatted with Format, e.g. "Time: 0.250000". It reports the time the pipeline asks it to update, not a dataset's time; when no time is requested the text is "?". Use pvAnnotateTimeFilter to label the time of a particular dataset, and pvText for fixed text.
  • pvAnnotateTimeFilter — Produces a one-row text table showing the input's current time, transformed as time × Scale + Shift and formatted with an fmt-style Format such as "Time: {time:.3f} s". Use it to label animations or images with physical time. It needs a time-dependent input; pvAnnotateTime is the source variant that needs no input.
  • pvAppendArcLength — Deprecated alias of pvPolylineLength: ParaView 5.13 marks AppendArcLength for removal in 5.14. It runs the same vtkAppendArcLength filter, adding a point array arc_length with the distance along each polyline from its first point (0 for points of other cell types).
  • pvAppendAttributes — Combines the point and cell arrays of several inputs that share the same geometry: the output copies the first input's geometry and adds every array from all inputs. Inputs whose point or cell count differs from the first are ignored for that attribute type, and a repeated array name gets the suffix input<n>. Use it to gather fields computed on separate branches of one mesh (e.g. gradient and cellSize results) into one node; use append or pvAppendDatasets to join different meshes.
  • pvAppendDatasets — Merges the meshes of several datasets into one. With OutputDataSetType Unstructured Grid (ParaView default) inputs of almost any type are appended; with Polygonal Mesh only polydata inputs are merged and the rest are left out. Only point and cell arrays present on every input are kept, and coincident points are not merged. Use it to combine separate nodes, e.g. two clipped regions; append is the curated equivalent, pvAppendGeometry keeps polydata, and merge or pvMergeBlocks flatten one composite input.
  • pvAppendGeometry — Appends several polygonal datasets (vtkPolyData) into one polydata, keeping vertices, lines, polygons and strips; only arrays present on every input survive and points are not merged. Use it to combine surfaces or lines from several nodes while staying polydata, e.g. for a surface writer; appendGeometry is the curated equivalent and pvAppendDatasets accepts mixed types.
  • pvAppendLocationAttributes — Adds point coordinates and cell centres as data arrays: PointLocations (3-component point array, a copy of each point's coordinates) and CellCenters (3-component cell array). Geometry and existing arrays are unchanged. Use it when a calculator, export or table needs coordinates as ordinary arrays, e.g. to compute a radius or write x, y, z to CSV. This is the old name of the same ParaView filter.
  • pvAppendMolecule — Appends one or more molecules (vtkMolecule) into a single molecule containing all atoms and bonds with their atom and bond data. The inputs must carry the same data arrays (same number and names). Use it to assemble a system from several molecule readers or pvConvertIntoMolecule nodes before bonding, rendering or export.
  • pvAppendReduce — Parallel data-movement filter (vtkReductionFilter with vtkAppendFilter as the post-gather helper): it gathers the pieces of a distributed dataset from all MPI processes and appends them into one unstructured grid on one process or on every process. Use it in MPI runs when a later step needs the whole dataset in one place; in a serial run there is only process 0, so it just appends the single piece. Input must be a non-composite vtkDataSet. To combine separate nodes use append or merge.
  • pvAppendSelections — Combines several selections (vtkSelection), for example ID, block and threshold selections, into one (vtkAppendSelection). With no Expression the inputs are joined with OR; with an Expression such as "(A|B)&!C" the inputs, named by SelectionNames in input order, are combined with | (or), & (and), ^ (xor) and ! (not). InsideOut inverts the result. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.
  • pvArrow — Creates a 3-D arrow of total length 1 along +x from the origin: a cylindrical shaft joined to a conical tip, as polydata without normals. Use it as a glyph shape or annotation; scale and orient it with a transform, or use pvGlyph to place many arrows on vector data.
  • pvAxes — Creates three line segments along the x, y and z directions from Origin, as polydata with normals and a point scalar "Axes" (0 on the x line, 0.25 on y, 0.5 on z), so colouring by that array distinguishes the axes. Each line has length ScaleFactor, or runs from -ScaleFactor to +ScaleFactor when Symmetric is true. Use it as an orientation reference in a scene.
  • pvAxisAlignedSlice — Slices hyper tree grids and overlapping AMR data with an axis-aligned plane while keeping the input type, so a 3-D hyper tree grid becomes 2-D hyper tree grids. For hyper tree grids each entry of OffsetValues gives one slice and the output is a partitioned dataset collection; for AMR one slice at the plane is produced, at resolution Level. Use slice or pvSlice for ordinary meshes.
  • pvBDFReader — Reads a Nastran Bulk Data File (.bdf) in free-field format into an unstructured grid. Only a small subset of entries is understood: GRID points, CTRIA3 triangles, PLOAD2 pressure loads (a cell array) and TITLE and TIME (field data); other entries such as CQUAD4 or CTETRA are skipped with a warning listing them. Use it for triangulated Nastran surfaces with pressure loads, not for general finite-element models.
  • pvBYUReader — Reads Movie.BYU geometry files (.g) into polydata made of polygons. Use it for legacy surface models in this format; companion displacement, scalar or texture files supported by vtkBYUReader are not exposed by the ParaView proxy, so only the geometry is read.
  • pvBlockIds — Adds a cell array named BlockIdScalars to every block of a multiblock dataset, holding the index of the block (unsigned char), so blocks can be coloured, thresholded or counted by block. The input must be a vtkMultiBlockDataSet; structure and other arrays are unchanged. Use extractBlock to keep selected blocks instead.
  • pvBlockScalars — Adds a cell array named BlockIdScalars to every block of a multiblock dataset, holding the index of the block (unsigned char), so blocks can be coloured, thresholded or counted by block. The input must be a vtkMultiBlockDataSet; structure and other arrays are unchanged. This is the old name of the same ParaView filter.
  • pvBlockSelectionSource — Creates a block selection: a vtkSelection naming whole blocks of a composite dataset by their flat (composite) index, so pvExtractSelection keeps just those blocks. Choose it when you know the numeric block indices; pvBlockSelectorsSelectionSource selects blocks by path, which is more robust, and extractBlock or pvExtractBlock extract blocks directly without a selection. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.
  • pvBlockSelectorsSelectionSource — Creates a block selection from selector paths (vtkPVSelectionSource with BLOCK_SELECTORS content): XPath-style expressions such as "/Root/internalMesh" or "//patch" evaluated against a data assembly of the composite dataset, by default ParaView's Hierarchy. Choose it over pvBlockSelectionSource when block names are known but indices may change. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.
  • pvBoundaryMeshQuality — Extracts the boundary faces of a volume mesh as polydata and, for each face, measures its relation to the volume cell it belongs to: DistanceFromCellCenterToFaceCenter, DistanceFromCellCenterToFacePlane (both in dataset length units) and AngleFaceNormalAndCellCenterToFaceCenterVector in degrees. Use it to inspect near-wall cell size and skewness, e.g. first-cell height on CFD walls. Input must be a volumetric grid (unstructured, structured, rectilinear or image data); use pvMeshQuality for whole-cell shape metrics.
  • pvBoundingRuler — Creates a line along the input's bounding box, along X, Y or Z, or along an oriented bounding-box axis, so its length is the extent of the data along that axis. ParaView displays it as a measured ruler; in Schemaxis the output is a polydata line that can be rendered or measured. Use pvRuler for a ruler between two chosen points.
  • pvBox — Creates an axis-aligned box as polydata with normals and texture coordinates: six quadrilateral faces centred at Center with edge lengths XLength, YLength and ZLength. Use it as reference geometry, a bounding region or a simple test surface. For a box defined by minimum and maximum corners as a wireframe use pvOutlineSource.
  • pvCGNSSeriesReader — Reads CFD General Notation System files (.cgns, ADF or HDF5 based) into a multiblock dataset organized by base and zone: each zone becomes a structured or unstructured grid and, with LoadPatches, its boundary-condition patches are added beside the volume mesh. Field arrays come from FlowSolution_t nodes as point, cell or face data, and several files in FileNames form a time series. Choose it for general CGNS solver output; use pvIOSSReader for CGNS files that the IOSS library supports, and pvCONVERGECFDCGNSReader for CONVERGE CGNS post files with parcels.
  • pvCMLMoleculeReader — Reads a Chemical Markup Language file (.cml, an XML description of atoms and bonds) into a vtkMolecule: atoms with element numbers and 3-D positions plus the bonds between them. vtkMolecule is not a mesh, so most dataset filters do not accept it; use pvMoleculeToLines to obtain polydata, or pvComputeMoleculeBonds to derive bonds. Use pvXYZReader or pvPDBReader for those formats.
  • pvCONVERGECFDCGNSReader — Reads CONVERGE CFD post-processing files written in CGNS (.cgns): the volume mesh, surfaces and parcels (Lagrangian spray or particle data stored in PARCEL_DATA UserDefinedData_t nodes) into a partitioned dataset collection with mesh and parcel datasets. Parcels become point clouds whose arrays are chosen in ParcelArrayStatus. Several files in FileNames form a time series. Use pvCONVERGECFDReader for CONVERGE HDF5 (.h5) post files and pvCGNSSeriesReader for general CGNS output.
  • pvCONVERGECFDReader — Reads CONVERGE CFD HDF5 post files (.h5) into a partitioned dataset collection: each stream in the file is a top-level group holding its mesh (cell data), surfaces and parcels (point clouds of spray or particle data). The reader detects a time series from files named <prefix><zero-padded index>[_<time>].h5 next to the chosen file and takes each file's time from its metadata. Use pvCONVERGECFDCGNSReader for CONVERGE output written as CGNS.
  • pvCSVReader — Reads delimited text (.csv, .tsv, .txt) into a table (vtkTable): one column per field, typed as numbers when DetectNumericColumns is on (ParaView default), with the first line as column names by default. The ParaView XML calls the output a 1-D rectilinear grid, but the underlying vtkDelimitedTextReader produces a table. Use pvTableToPoints or pvTableToStructuredGrid to turn coordinate columns into geometry; several files form a time series.
  • pvCalculator — Full native Calculator: evaluates an expression over point, cell, row or other attribute arrays and stores the result as a new array of a chosen numeric type, or, with CoordinateResults, as new point coordinates (moving the mesh), or as normals or texture coordinates. Output has the input's data type. Use calculator for the common point/cell array case.
  • pvCellCenters — Replaces each cell by a point at its parametric centre and outputs polygonal data; the input cell arrays become point arrays on those points. Use it to place glyphs or labels per cell, to probe or export cell-centred solver values as a point cloud, or as seeds. With VertexCells on, a vertex cell is added per point so the points render and count as cells. pvCoordinates instead keeps the mesh and adds centres as an array.
  • pvCellDatatoPointData — Converts cell-centred arrays to point-centred arrays by averaging, at each point, the values of the cells that use it; the output has the same dataset type. Needed before operations that require point data, such as contouring, streamline tracing or smooth colouring of solver results stored per cell. It is the native filter behind cellToPoint, which keeps the cell data by Schemaxis default; pvCellDatatoPointData keeps ParaView's defaults, which convert all arrays and drop the original cell arrays.
  • pvCellGridElevation — Adds a scalar attribute (default name Elevation) to a cell grid (vtkCellGrid) measuring distance from Origin: along Axis for Planar distance (ParaView default), from the line through Origin along Axis for Cylindrical distance, or from Origin itself for Spherical distance. Shock adds an offset that makes the field jump between cells, intended to demonstrate discontinuous Galerkin (DG) cells. Use it on cell-grid data from pvConvertToCellGrid or pvIOSSCellGridReader; for ordinary datasets use elevation or pvElevation.
  • pvCellGridProbe — Probes a cell grid (Source port, vtkCellGrid) at the points of a polydata (Input port): the output polydata keeps the probe points that lie inside cells of the cell grid, with the chosen cell-grid attribute interpolated to them. A point inside several overlapping cells, typically on a shared boundary, appears once per cell. Use it to sample DG or other cell-grid fields along lines or at locations; for ordinary datasets use resample, pvResampleWithDataset or probeLine.
  • pvCellSize — Full native Cell Size filter: adds cell-data arrays with the point count of 0-D cells (VertexCount), the length of 1-D cells (Length), the area of 2-D cells (Area) and the volume of 3-D cells (Volume), in dataset coordinate units. Cells of other dimensions get 0 in each array. With ComputeSum the totals per array are also stored as one-value field-data arrays of the same names; for composite input the top-level output holds the sum over all blocks. Use it instead of cellSize when you need custom array names or to switch off the vertex count.
  • pvCesium3DTilesReader — Reads a Cesium 3D Tiles tileset (the tileset .json file and the glTF, GLB or B3DM tiles it references) into a partitioned dataset collection with one partitioned dataset per tile. Coordinates stay in the tileset's Cartesian frame, typically Earth-centred metres for georeferenced city or terrain models. Use it to bring photogrammetry or city meshes into a pipeline; Level chooses how deep in the tile tree to read.
  • pvCityGMLReader — Reads a CityGML (.gml) city model into a multiblock dataset: top-level blocks per CityGML element type (buildings, roads, water bodies, vegetation …) labelled by an element field array, with polygonal leaves carrying a gml_id field array and, when textured, tcoords and a texture_uri. Only the chosen level of detail (LOD) is read. Use it for urban geometry, e.g. as obstacles for wind or dispersion studies.
  • pvClean — Cleans polygonal data: merges duplicate or nearby points, removes unused points and converts degenerate cells to lower-dimensional forms (a triangle with two merged points becomes a line, a zero-length line a point). Use it before operations that need connected topology, such as featureEdges, normals, pvDecimate or connectivity, on surfaces with duplicated vertices (STL, per-face exports). clean is the curated version; cleanGrid handles unstructured grids.
  • pvCleanCellstoGrid — Removes duplicate cells (cells using the same set of points) from an unstructured grid and repairs cells that reference the same point more than once; the output is an unstructured grid. Use it after merging meshes or importing data with repeated elements. It assumes duplicate points were merged already, so run pvCleantoGrid first.
  • pvCleantoGrid — Merges coincident or nearly coincident points and converts any dataset to an unstructured grid, e.g. to join blocks that share faces or to feed an operation that needs unstructured input. Merging uses Tolerance (fraction of the bounding-box diagonal) or AbsoluteTolerance, and PointDataWeightingStrategy decides how data on merged points is combined. Use cleanGrid for the common case with Schemaxis defaults.
  • pvClientServerMoveData — ParaView-internal helper that copies data from the server's root process to the client in a client-server session; without a remote connection it is a pass-through filter. Because the receiving side must create its output before data arrive, the output type is fixed by OutputDataType (and image extent by WholeExtent) rather than taken from the input. It has no analysis value in a Schemaxis pipeline; use passArrays or no filter at all.
  • pvClip — Full native Clip: cuts the input with an implicit function chosen in ClipType (Plane, Box, Sphere, Cylinder) or with a scalar iso-value (ClipType Scalar plus Scalars and Value) and keeps one side, returning an unstructured grid. Crinkleclip keeps whole cells instead of cutting them. HyperTreeGridClipper replaces ClipType for hyper-tree-grid input. Use clip for a simple plane clip with Schemaxis defaults.
  • pvClipClosedSurface — Clips a closed, manifold polygonal surface with a plane and caps the cut with new faces, so the result is again a closed (watertight) surface, e.g. to cut a CAD solid or an STL body and still compute its volume. Output is polydata; GenerateCellOrigins can add cell scalars that distinguish original faces from cap faces. Use clip or pvClip for volume meshes.
  • pvColorByArray — Converts one single-component point array of an image (vtkImageData) into colour values by passing it through a lookup table, producing image data whose scalars are unsigned char luminance, luminance-alpha, RGB (ParaView default) or RGBA tuples. Connect the LookupTable input to a lookup-table resource node such as pvResourcePVLookupTable; its value range and colours decide the mapping. Use it to bake a colour map into image data, e.g. before writing a PNG with pvWritePNGWriter; for on-screen colouring use scene appearance settings instead.
  • pvCompositeCellGridReader — Reads cell-grid data (.dg JSON files, e.g. discontinuous Galerkin or other high-order results) into a partitioned dataset collection of vtkCellGrid objects, keeping only the selected cell types and cell attributes. Cell grids store fields with their own interpolation rules rather than as ordinary point or cell arrays, so only filters that support vtkCellGrid accept the output directly. It is a distributed reader.
  • pvCompositeDataIDSelectionSource — Creates an ID selection for composite data (multiblock or AMR): each entry names a block by flat index, a process (piece) and an element id within that block, interpreted as cell or point ids according to FieldType. Use it to pick specific cells or points in specific blocks, for example probe cells reported by an earlier run. For non-composite data use pvIDSelectionSource. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.
  • pvComputeConnectedSurfaceProperties — Deprecated alias of pvConnectedSurfaceProperties (ParaView 5.13 marks it for removal in 5.14); behaviour is identical. Computes the volume, surface area and centroid of each closed object in a polygonal input, plus totals; objects are found as connected components, or taken from an object-ID cell array. Per-object results go to field data (ObjectValidity, ObjectVolumes, ObjectAreas, ObjectCentroids) and per-polygon ObjectIds, Areas and Volumes to cell data. Use it to measure particles, droplets or parts in one surface mesh; use integrate for general integrals.
  • pvComputeDerivatives — Computes derivatives of point data at each cell's parametric centre and stores them as cell arrays: ScalarGradient (gradient of the selected point scalar) or Vorticity as the vector output, and VectorGradient (9-component tensor) or Strain as the tensor output. Input point and cell data pass through. Use it for cell-wise gradients of point fields on any mesh; use gradient or pvGradient for point-centred gradients and Q-criterion.
  • pvComputeMoleculeBonds — Adds single bonds to a molecule (vtkMolecule) from interatomic distances alone: two atoms are bonded when their distance is below the sum of their covalent radii widened by Tolerance. Valence, hybridization, aromaticity and bond order are ignored, so every bond is single. Use it when atoms come without connectivity, e.g. after pvConvertIntoMolecule or a coordinate-only reader, and follow with pvMoleculeToLines to turn the bonds into line cells.
  • pvComputeQuartiles — Computes, for every single-component numeric array, the five order statistics minimum, lower quartile, median, upper quartile and maximum, and outputs them as a table (vtkTable) with one column per array and five rows. For a dataset the point-data arrays are used; a table input uses its columns, and composite input adds one column per block (suffix Block<id>). Use it for box-plot style summaries of a field's distribution; use pvHistogram for the full distribution.
  • pvComputeSides — Adds arrays to a cell grid (vtkCellGrid) listing the unshared sides of its cells, i.e. external surfaces and non-conforming internal interfaces, as (cell id, side id) pairs grouped by cell type and side shape. ParaView's cell-grid representation uses these arrays to render the grid efficiently; the cells themselves are unchanged. Use it when preparing cell grids from pvConvertToCellGrid for rendering or boundary extraction.
  • pvConduit — In-situ source that converts a Conduit node following the Mesh Blueprint into a VTK dataset. The node is handed over in memory by a running simulation through Catalyst, not read from a file, so a Schemaxis document cannot supply its data. Use file readers for stored results.
  • pvCone — Creates a cone as polydata: a polygonal approximation with Resolution side facets, axis along Direction, height Height and base radius Radius, centred at Center (the midpoint of the axis), with the base capped by default. Use it as reference geometry or a glyph shape. The curated cone operation offers the same geometry with Schemaxis defaults and validated ranges.
  • pvConnectedSurfaceProperties — Computes the volume, surface area and centroid of each closed object in a polygonal input, plus totals; objects are found as connected components, or taken from an object-ID cell array. Per-object results go to field data (ObjectValidity, ObjectVolumes, ObjectAreas, ObjectCentroids) and per-polygon ObjectIds, Areas and Volumes to cell data. Use it to measure particles, droplets or parts in one surface mesh; use integrate for general integrals.
  • pvConnectivity — Finds connected regions (cells linked through shared points) and outputs an unstructured grid of all regions, the largest one (most cells) or the one closest to ClosestPoint, per ExtractionMode. With ColorRegions (ParaView default true) RegionId arrays number the regions, in the order RegionIdAssignmentMode sets. Use it to separate disjoint parts, remove small fragments or isolate one body; connectivity is the curated version with fewer settings.
  • pvContingencyStatistics — Builds contingency tables (joint frequency counts) for pairs of the selected arrays, giving a bivariate probability model and the information entropy, and can assess each observation with joint and conditional probabilities and pointwise mutual information. It suits categorical or discrete variables such as material ids or flags. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.
  • pvContour — Full native Contour: isosurfaces or isolines of a point scalar (cell scalar for hyper tree grids) at each value in Isosurfaces, output as polydata, with options for normals, gradients, contour-value scalars, triangle output, fast mode for image data, the 3-D strategy, point precision and point merging. Use contour for the common case with Schemaxis defaults.
  • pvConvertAMRdatasettoMultiblock — Converts overlapping AMR data (vtkOverlappingAMR) into a multiblock dataset whose leaves are the individual uniform-grid blocks, so filters or writers that do not understand AMR can process them. The result is a flat multiblock with one block per AMR grid, listed level by level; grids are shallow copies, so their arrays (including any blanking array) are kept, but level and refinement metadata are lost and coarse cells covered by finer levels are not removed. Use pvResampleAMR instead when you need a single uniform grid.
  • pvConvertIntoMolecule — Turns a point set (polydata, unstructured grid or another vtkPointSet) into a molecule (vtkMolecule): every point becomes an atom at the same position, its element read from a one-component point array of atomic numbers, and the other point arrays become atom data. With ConvertLinesIntoBonds (ParaView default true) each line cell becomes a bond. Use it to bring particle or simulation output into the chemistry operations pvComputeMoleculeBonds, pvAppendMolecule and pvMoleculeToLines.
  • pvConvertPolyhedralCells — Tries to convert polyhedron (and polygon) cells of an unstructured grid into equivalent simple cells (tetrahedron, pyramid, wedge, hexahedron) when their topology allows; cells that cannot be converted stay as they are. Output is an unstructured grid. Use it on meshes from polyhedral-capable readers such as OpenFOAM to speed up later processing and to allow operations that handle simple cells better.
  • pvConvertSelection — Converts a selection (a vtkSelection on the Input port, e.g. from pvIDSelectionSource or pvLocationSelectionSource) into another content type, evaluated against the dataset on DataInput: for example cell indices become the global IDs, or the values of a named array, at those cells. The output is again a vtkSelection with no geometry; feed it to pvExtractSelection or pvAnnotateSelection. vtkConvertSelection can produce INDICES, GLOBALIDs, PEDIGREEIDS or VALUES from another type; FRUSTUM, LOCATIONS and THRESHOLDS are only accepted when the input selection already has that type.
  • pvConvertToCellGrid — Converts an unstructured grid, or a composite whose leaves are unstructured grids with linear cells, into a partitioned dataset collection of cell grids (vtkCellGrid). Field-data annotations written by the IOSS reader promote certain cell arrays to spatially varying discontinuous Galerkin (DG) attributes; data without annotations is converted too. Use it before pvComputeSides, pvCellGridElevation or pvCellGridProbe.
  • pvConvertToMultiBlock — Wraps any input — a single dataset, table, graph or composite — in a vtkMultiBlockDataSet: a non-composite input becomes one block, other composites keep their hierarchy, and a multiblock passes through. Use it when a later step or writer expects multiblock data, e.g. pvWriteXMLMultiBlockDataWriter; pvConvertToPartitionedDataSetCollection produces the newer partitioned format.
  • pvConvertToPartitionedDataSetCollection — Converts any input to a vtkPartitionedDataSetCollection. Multiblock and AMR inputs get a data assembly that reproduces their hierarchy, so blocks can still be chosen by path with extractBlock or pvExtractBlock. Use it for steps or writers that require partitioned collections, such as pvWriteXMLPartitionedDataSetCollectionWriter; pvConvertToMultiBlock produces the older multiblock format.
  • pvConvertToPointCloud — Converts any dataset into polydata that keeps only the input points and their point-data arrays; cells and cell data are dropped. CellGenerationMode decides whether the result has one vertex cell per point (ParaView default), a single polyvertex cell, or no cells at all. Use it to treat mesh nodes or particles as a point cloud, e.g. before pvPCANormalEstimation or point-based interpolation.
  • pvCoordinates — Adds point coordinates and cell centres as data arrays: PointLocations (3-component point array, a copy of each point's coordinates) and CellCenters (3-component cell array). Geometry and existing arrays are unchanged. Use it when a calculator, export or table needs coordinates as ordinary arrays, e.g. to compute a radius or write x, y, z to CSV. pvCellCenters instead produces points at the cell centres.
  • pvCosmoReader — Reads binary cosmology particle files in LANL cosmo format (.cosmo, .cosmo64) or Gadget-2 format (vtkPCosmoReader) into an unstructured grid of particles with point arrays velocity, mass, tag and ghost. Several file names form a time series, one file per time step. Its output is the expected input of pvLANLFOFSODHaloFinder. Use pvGenericIOReader for HACC GenericIO output.
  • pvCountCellFaces — Adds a cell array (default name "Face Count") with the number of faces of each cell, as reported by VTK: 6 for a hexahedron, 4 for a tetrahedron, the face count of a polyhedron, and 0 for 2-D and lower cells, whose edges are not faces. Use it to inspect polyhedral meshes, e.g. from snappyHexMesh, or to threshold cells by face count.
  • pvCountCellVertices — Adds a cell array (default name "Vertex Count") with the number of points of each cell, e.g. 3 for triangles, 8 for hexahedra and the point count of polygons and polyhedra. Use it to check mixed meshes or threshold cells by type-like size.
  • pvCriticalTime — Scans every time step of a temporal input and records, for each point or cell, the first time value at which the selected array meets a threshold criterion (above, below or between thresholds; comparisons include the threshold values). The result is a static (non-temporal) dataset with one array named <array>_critical_time; other point and cell arrays are dropped, and entries whose criterion is never met are NaN. Use it for arrival or exceedance maps, e.g. when temperature first exceeds a limit. The mesh must keep the same points and cells over time.
  • pvCrop — Extracts a sub-block of an image or volume (vtkImageData) given as a point-index extent [imin, imax, jmin, jmax, kmin, kmax]; the output keeps the input origin and spacing, so cropped points stay at their original positions. Use it to cut a region of interest from a large image before costly filtering or export. To cut by world coordinates or with an arbitrary shape use clip; extractSubset selects an index range with sampling rates as well.
  • pvCurvature — Generated binding of ParaView's Curvature filter: computes per-point Gaussian (ParaView default) or mean curvature of a polygonal surface into the point array Gauss_Curvature or Mean_Curvature. Gaussian curvature is positive on sphere-like and negative on saddle-like regions (units 1/length²); mean curvature (1/length) assumes outward normals. Use the curated curvature (Schemaxis default Mean) for the usual case; this binding defaults to Gaussian.
  • pvCylinder — Creates a cylinder as polydata with normals and texture coordinates: Resolution side facets, axis parallel to y, centred at Center, with both ends capped by default. Use it as reference geometry, e.g. a pipe or probe region. The orientation is fixed to y; rotate it with transform for other axes.
  • pvD3 — Parallel repartitioning (distributed data decomposition): builds a k-d tree over the distributed dataset and redistributes cells so each MPI process owns a spatially contiguous, load-balanced region, optionally with ghost-cell layers; output is an unstructured grid. In a serial run it acts almost as a pass-through, but non-composite input is still converted to an unstructured grid. pvRedistributeDataSet is the newer alternative with more output control.
  • pvDEMReader — Reads a USGS Digital Elevation Model (.dem, the ASCII DEM format) into 2-D uniform image data whose point scalars are elevations; origin and spacing come from the DEM header. Use pvWarpByScalar or warpScalar to turn it into a 3-D terrain surface.
  • pvDICOMReaderSingleFile — Reads one uncompressed DICOM file (.dcm) into uniform image data with the pixel values as point scalars and the pixel spacing from the header. Use it for a single slice; for a series stored as one slice per file use pvDICOMReaderdirectory.
  • pvDICOMReaderdirectory — Reads every DICOM file in one directory as the slices of a single 3-D image volume (uniform image data), the usual layout of CT and MR series. In Schemaxis, FileName must be the directory itself: the value goes straight to vtkDICOMImageReader's SetDirectoryName. Use pvDICOMReaderSingleFile for one file.
  • pvDataObjectGenerator — Builds small test datasets from a text Program: atomic templates ID1 (image data), UF1 (uniform grid), RG1 (rectilinear), SG1 (structured), PD1/PD2 (polydata) and UG1 (unstructured grid), nested in composites with MB{ … } (multiblock) or HB[ … ] (hierarchical box AMR, levels in parentheses). For example "MB{ ID1 PD1 MB{} }" gives a multiblock of an image, a polydata and an empty block. Use it to exercise how a pipeline handles particular data types and composite structures.
  • pvDateToNumeric — Finds string arrays holding dates (point, cell, field or table row data) and adds a numeric copy of each as <name>_numeric, in seconds since the Unix epoch, so dates can be plotted, thresholded or used in calculators. VTK tries DateFormat first, then built-in fallback formats; the format is chosen from the first value, and an array whose first value does not parse is skipped. Typical input is a CSV table read with a CSV reader.
  • pvDecimate — Reduces the triangle count of a triangle surface with vtkDecimatePro, removing vertices in order of least error until TargetReduction (ParaView default 0.9, about 90 % of triangles removed) is reached. By ParaView default PreserveTopology is off, so the surface may be split along feature edges (FeatureAngle 15°) and holes may open to reach the target. Input must be triangles; run triangulate first. decimate is the curated version (Schemaxis defaults 0.5, topology preserved); pvQuadricClustering is faster on very large meshes.
  • pvDecimatePolyline — Reduces the points of polylines by repeatedly deleting the interior vertex with the smallest error until TargetReduction (ParaView default 0.9) of the segments is removed or the next deletion would exceed MaximumError. The error comes from DecimationStrategy: distance of a vertex from the line through its neighbours (Decimation Distance Strategy, default), the angle at the vertex, or a custom point array. End points are kept, but closed loops can collapse to one segment. Use it to simplify streamlines, contours or GIS polylines.
  • pvDeflectNormals — Tilts surface normals by a vector field: each new normal is normalize(N + ScaleFactor × V), where N is the input point normal (or the constant UserNormal) and V the selected point vector. The result is a point normal array DeflectedNormals set as the active normals; geometry is unchanged. It is a shading effect for visualizing a vector field on a surface (e.g. bump-like lighting from velocity), not a physical quantity.
  • pvDelaunay2D — Full native Delaunay 2D: triangulates input points (vtkPointSet) into polydata triangles. Beyond delaunay2D it exposes ProjectionPlaneMode — XY Plane (default) ignores z, Best-Fitting Plane projects the points onto their least-squares plane first so tilted, nearly planar sets triangulate correctly — and Offset and BoundingTriangulation, which control the initial bounding triangulation. Alpha and Tolerance act as in delaunay2D (ParaView defaults 0 and 0.00001).
  • pvDelaunay3D — Full native Delaunay 3D: tetrahedralizes input points (vtkPointSet) into an unstructured grid. Beyond delaunay3D it exposes which alpha-shape cell types are output when Alpha > 0 (AlphaTets and AlphaTris on, AlphaLines and AlphaVerts off by ParaView default), the Offset of the initial bounding tetrahedralization (default 2.5) and BoundingTriangulation. Alpha and Tolerance act as in delaunay3D (ParaView defaults 0 and 0.001).
  • pvDescriptiveStatistics — Computes univariate statistics of each selected array: minimum, maximum, mean, raw moments, standard deviation, skewness and kurtosis. Assessment expresses each value as its number of standard deviations from the mean (signed or unsigned). Use it for summary statistics of fields over a mesh or table; counts are per point or cell, not weighted by cell size. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.
  • pvDisk — Creates a flat annulus (a disk with a central hole) in the x-y plane centred at the origin, as polydata made of quadrilaterals: InnerRadius to OuterRadius, divided into RadialResolution rings and CircumferentialResolution sectors. Use it as an inlet or outlet patch, seed surface or reference geometry. The curated disk operation exposes the same source with Schemaxis defaults.
  • pvDistributePoints — Redistributes the points of a point set across MPI processes into spatially contiguous regions with roughly equal point counts, by recursively splitting the points in two (a k-d tree). Output is polydata containing the points and their point data but no cells; input cells are ignored. Use it in MPI runs to balance particle or point-cloud data before point-based processing.
  • pvDistributedTrivialProducer — Trivial producer (vtkDistributedTrivialProducer) that takes its data from a dataset previously registered under a key by native code in the same process (SetGlobalOutput); UpdateDataset names that key. Schemaxis provides no way to register such a dataset, so in a workflow the key finds nothing and the node has no data. It exists for in-situ and embedding applications.
  • pvENZOAMRParticlesReader — Reads particles from an Enzo AMR output (the .hierarchy or .boundary file of a data dump) into a multiblock dataset with one polydata block of particle points per grid. It can keep only every Frequency-th particle, particles inside a box, or one particle type (dark matter, star or tracer). Use pvEnzoReader for the gas fields of the same output.
  • pvERFHDF5datareader — Reads ESI Result Format files stored in HDF5 (.erfh5), as written by ESI structural and crash solvers, into a partitioned dataset collection. A file holds stages (top-level groups; the "post" link names the default stage), each with constant data (mesh connectivity, nodes) and singlestate time states; Stages, Blocks and Variables choose what is read. Multistate data are not supported.
  • pvElevation — Adds a floating-point point array named Elevation by projecting each point onto the segment from LowPoint to HighPoint and mapping its position linearly into ScalarRange: the LowPoint end gets the first value, the HighPoint end the second, and points beyond either end are clamped. Use it for height colouring, a linear test ramp or a coordinate along any direction; elevation is the curated version and pvCellGridElevation works on cell grids.
  • pvEllipse — Creates an elliptical arc or full ellipse as a polyline: centred at Center, in the plane normal to Normal, with major radius given by the length of MajorRadiusVector and minor radius Ratio × major. StartAngle and SectorAngle (degrees, measured from the major axis) select part of the perimeter, and Close joins the ends. Use it for annotation, seed curves or circular probes (Ratio 1 gives a circle).
  • pvEnSightMasterServerReader — Reads EnSight data written in parallel through a Server-of-Servers master file (.sos) that lists one .case file per partition; the partitions are combined into one multiblock dataset of EnSight parts with the selected node and element variables. Choose it for EnSight output split across processes; for an ordinary .case file use pvEnSightReader. It reads the time given by SetTimeValue and exposes a ByteOrder setting for binary files.
  • pvEnSightReader — Reads an EnSight 6 or EnSight Gold case (.case, ASCII or binary), a post-processing format exported by many CFD and structural solvers (OpenFOAM's foamToEnsight among them). Output is a multiblock dataset with one block per EnSight part, carrying the node (point) and element (cell) variables selected in PointArrays and CellArrays; transient cases expose their time steps. Use pvEnSightMasterServerReader for a parallel .sos master file and pvWriteEnSightWriter to write EnSight.
  • pvEnsembleDataReader — Reads a ParaView ensemble table (.pve): a CSV file with a header row in which each further row describes one ensemble member through parameter columns, and the last column gives that member's data file, relative to the .pve file. CurrentEnsembleMember selects which member is read; the output is whatever that file's reader produces. Use it to step through a parameter study by member number; read a member's file directly when only one is needed.
  • pvEnvironmentAnnotation — Produces a text annotation stating the user name, system name, date and time and, optionally, the input's file name, for stamping provenance on images. ParaView marks its output port as text: it is an annotation, not a dataset, and the input data are not passed through. The text depends on the machine, user and run time.
  • pvEnzoReader — Reads an Enzo AMR simulation output (the .hierarchy or .boundary file) into a hierarchical-box (overlapping AMR) dataset of the selected cell and point fields, refinement levels 0 to Level. ConvertToCGS optionally converts the fields from Enzo code units to CGS. Use it for Enzo gas and field data; use pvENZOAMRParticlesReader for its particles.
  • pvEqualizerFilter — Applies a frequency-domain equalizer to signal columns of a table: each column is Fourier transformed, its spectrum multiplied by a piecewise-linear gain curve given in EqualizerPoints, and transformed back. Output ports: 0 the spectrum, 1 the filtered signal (Result), 2 the normalized spectrum; select one with {"node": id, "port": n}. Use it for band-pass or notch filtering of probe or sensor time series.
  • pvEvenlySpacedStreamlines2D — Fills a 2-D vector field with streamlines at roughly uniform spacing (Jobard–Lefer algorithm): starting at StartPosition it integrates forward and backward, seeds new lines SeparatingDistance beside existing ones, and stops a line when it comes closer than SeparatingDistance × SeparatingDistanceRatio to another, closes a loop, leaves the domain, slows below TerminalSpeed or reaches MaximumSteps. Input must lie in the x-y plane with in-plane point vectors; output is polylines with IntegrationTime, interpolated fields and a ReasonForTermination cell array. Use it for even flow pictures of 2-D slices; streamTracer seeds from a chosen source.
  • pvExodusIIReader — Reads Exodus II finite-element results (.e, .exo, .g, .ex2 …, written by SEACAS-based codes such as Sierra, MOOSE or Cubit) into a multiblock dataset of unstructured grids: element blocks, optional face and edge blocks, node, side and element sets, and global variables, with nodal and element result variables per time step. By default node positions include the displacement vector (ApplyDisplacements, scaled by DisplacementMagnitude). Use pvRestartedSimExodusReader for a restarted run described by a metadata file, or pvIOSSReader, the IOSS-based alternative.
  • pvExtractAMRBlocks — Extracts chosen datasets (boxes) from an AMR input (vtkUniformGridAMR), each identified by its refinement level and its index within that level. The output is a multiblock with one block per level, each holding the extracted uniform grids as pieces. Use it to inspect or process individual AMR patches; pvConvertAMRdatasettoMultiblock or pvResampleAMR convert the whole hierarchy instead.
  • pvExtractAttributes — Converts one attribute association of the input (points, cells, field data, vertices, edges or rows) into a table (vtkTable): one column per array, one row per point or cell (or other element). Composite input gives a multiblock of tables. Use it to inspect or export raw array values, e.g. as CSV through a table writer. Geometry and connectivity are dropped unless AddMetaData adds coordinates.
  • pvExtractBlock — Full native Extract Block: keeps selected blocks of a multiblock, partitioned dataset collection or AMR input, chosen by Selectors (path expressions) evaluated against the data assembly named in Assembly — the block hierarchy, or an assembly supplied by readers such as IOSS or CGNS that groups blocks by meaning. The composite type is kept (overlapping AMR becomes a partitioned dataset collection). Use extractBlock when the hierarchy is enough.
  • pvExtractCTHParts — Specialized for CTH shock-physics results: for each selected cell-centred volume-fraction array (VolumeArrays) it converts the array to point data and contours it at VolumeFractionValue (ParaView default 0.45), giving one material surface per array. Output is a multiblock with one polydata block per selected array, optionally clipped by a plane (ClipType, ParaView default None) and capped to look closed. Input is CTH data: non-overlapping AMR or multiblock rectilinear grids with cell data, e.g. from pvSpyPlotReader.
  • pvExtractCellsAlongLine — Extracts every cell of the input that the straight segment from Point1 to Point2 intersects and outputs those cells, with their point and cell data, as an unstructured grid. Use it to inspect the actual mesh cells crossed by a probe line, for example before plotting with probeLine; probeLine instead samples interpolated values at evenly spaced points. Use pvExtractCellsAlongLinesCustomSource for polylines or several lines.
  • pvExtractCellsAlongLinesCustomSource — Extracts the input cells intersected by the line and polyline cells of a second dataset (Source, polydata or unstructured grid) and outputs them as an unstructured grid. Use it with a curved or multi-segment path, e.g. a traced streamline or a polyline read from a file; for a single straight segment pvExtractCellsAlongLine is simpler.
  • pvExtractCellsByRegion — Extracts the cells lying entirely inside (ParaView default) or entirely outside an implicit region — a Plane (ParaView's default choice, whose inside is the side opposite its normal), Box or Sphere — without cutting them, and outputs an unstructured grid. Extractintersected adds cells straddling the region boundary and Extractonlyintersected keeps only those. Use it to cut out a sub-volume of whole original cells; clip cuts cells exactly at the surface and slice returns the surface itself.
  • pvExtractCellsByType — Keeps only the cells whose VTK cell type is listed in CellTypes, e.g. the Tetrahedron cells of a mixed mesh, or the Triangle and Quadrilateral faces of a surface. The output has the same dataset type as the input; structured inputs (image, rectilinear or structured grids) consist of one cell type, so they come through either whole or empty. Use pvExtractSelection to pick cells by ID or value instead.
  • pvExtractComponent — Copies one component of a multi-component array (e.g. the z velocity Uz from U) into a new single-component array named OutputArrayName on the same points or cells; the dataset is otherwise unchanged. Use it when a later operation (contour, threshold) needs a scalar. calculator can do the same with an expression such as U_Z.
  • pvExtractEdges — Native Extract Edges, the same filter as edges: every cell edge becomes a line cell in an output polydata wireframe, with shared edges emitted once and cell data copied from the lowest-numbered cell using the edge. Use edges unless you need the generated pv identifier; featureEdges or pvFeatureEdges return only boundary and sharp edges.
  • pvExtractEnclosedPoints — Keeps the input points that lie inside a closed, manifold polygonal Surface (second input) and outputs them as a point cloud (polydata) on port 0; with GenerateOutliers, port 1 holds the points outside. Only points and their point data are kept, not the input's cells. Use it to select particles or probe points within a body; to keep mesh cells, use a clip instead.
  • pvExtractGhostCells — Extracts only the ghost cells of the input (the overlap layers that parallel or partitioned data carry to neighbouring pieces) so they can be inspected, and records the original ghost flags in an array named ArrayName. Use it to debug decompositions or ghost-cell generation; data without ghost cells gives an empty output.
  • pvExtractLocation — Looks up one point in space: in Interpolate At Location mode it outputs a single point with all data interpolated there (a probe); in Extract Cell At Location mode, the ParaView default, it outputs the cell or cells containing the location with their data. Use it for a monitoring-point value or to inspect the element at a position; use probeLine or pvPlotOverLine for lines.
  • pvExtractParticlesOverTime — Finds the particles of a temporal point dataset (Particles port) that pass through a volume (Volume port, a dataset with 3-D cells) at any time step, and outputs the Particles data restricted to those particles, still time-dependent. It visits every input time step, so it can be slow. Particles are matched between steps by IdChannelArray. Use it to isolate particles crossing a region such as an inlet or a reaction zone; pvExtractCellsByRegion selects by position at one time only.
  • pvExtractRegionSurface — Extracts polygonal surfaces of an unstructured grid on its outer boundary and also on internal interfaces between regions, where regions are defined by an integer cell array (RegionArrayName, ParaView default "material"). It suits multi-material meshes: each interface face is output once or once per side (SingleSided), and output faces can record their source cell (OrigCellIds) and the face of that cell (CellFaceIds). Use surface or pvExtractSurface when only the outer boundary is needed.
  • pvExtractSelection — Extracts the points or cells described by a selection (Selection port, from one of the pv*SelectionSource operations or pvConvertSelection) from Input. By default the result is an unstructured grid holding only the selected elements (a table of selected rows for table input); with PreserveTopology it is a copy of the input with a vtkInsidedness array marking selected elements. Use it to isolate cells by ID, value, threshold, location, frustum or query.
  • pvExtractSelectioninternal — Internal ParaView variant of Extract Selection (vtkPVExtractSelection) with three output ports: 0 the extracted dataset, 1 a selection of the extracted point/cell indices, and 2 the input selection passed through; select a port with {"node": id, "port": n}. ParaView documents it as internal and recommends Extract Selection; use pvExtractSelection unless you need the index selection on port 1.
  • pvExtractSubset — Extracts a sub-block of a structured dataset (image data, rectilinear or curvilinear grid) by point-index ranges in I, J and K, optionally keeping only every n-th index; the output has the same structured type. Use it to crop or coarsen a structured grid cheaply, e.g. one K-plane of a 3-D grid. Use extractSubset for the same operation with Schemaxis defaults (includeBoundary true).
  • pvExtractSubsetWithSeed — From a structured grid (vtkStructuredGrid, including multiblock structured data split across blocks or processes), extracts the grid line (I, J or K) or grid surface (IJ, JK or KI) that passes through the cell containing Seed, following it across block boundaries even when block i-j-k origins differ. Typical use: pick a point to extract a wall-normal grid line or a constant-k surface of a curvilinear CFD mesh. Output keeps the structured cells, as a partitioned dataset for a single grid or the input's composite type otherwise.
  • pvExtractSurface — Extracts the outer surface of any dataset as polygonal data (vtkGeometryFilter): boundary faces of 3-D cells plus all lower-dimensional cells, with point and cell arrays carried over and internal faces removed. It is the same native filter as the curated surface operation, which has no options; choose pvExtractSurface to control nonlinear-face subdivision, fast mode, ghost-interface removal or piece invariance. For interfaces between materials use pvExtractRegionSurface.
  • pvExtractTimeSteps — Restricts a time-varying input to selected time steps, given as listed zero-based indices (Select Time Steps, ParaView default) or as an inclusive index range with a stride (Select Time Range). Downstream nodes see only those steps: a request for an unselected time is answered by a selected step chosen by ApproximationMode (Nearest Time Step by default), and times outside the selection get the first or last selected step. Use it to thin a long transient before temporalStatistics or pvParticlePath, or to hold a branch at one step.
  • pvFDSReader — Reads Fire Dynamics Simulator results through the Smokeview .smv file, which lists the other output files. The output is a partitioned dataset collection with five groups: Grids (meshes), Devices (point measurements over time), HRR (heat-release-rate tables), Slices and Boundaries (field data on planes and walls). AssemblySelectors chooses which of these are read. Use it for fire and smoke CFD from NIST FDS.
  • pvFFTOfSelectionOverTime — ParaView's compound filter that extracts the values of selected points or cells over all time steps (as Plot Selection Over Time does) and applies a discrete Fourier transform to each resulting time series (Table FFT), producing tables for spectral plots. Connect Input to the temporal dataset and Selection to a selection-source node (e.g. pvIDSelectionSource or pvLocationSelectionSource). Use it to find dominant frequencies of probe signals such as vortex shedding; use pvPlotSelectionOverTime and pvTableFFT separately when you need the frequency column or windowing.
  • pvFLASHAMRParticlesReader — Reads particles from a FLASH HDF5 checkpoint or plot file into a multiblock dataset of polydata particle points with the selected particle arrays. Frequency keeps every N-th particle and FilterLocation keeps only particles inside a box. Use pvFlashReader for the grid fields of the same FLASH output.
  • pvFacetReader — Reads a Facet file (.facet): a simple ASCII format listing point coordinates and the polygons connecting them, producing polygonal data. Use it for legacy surface geometry exported in this format; for common CAD exchange use readSTL or readPLY.
  • pvFastUniformGrid — Synthetic source producing a 3-D uniform grid (image data) with cheap analytic point arrays: X (the x index, active scalars), optionally DistanceSquared (squared distance from the origin) and Swirl (the vector (y, z, x)). Use it for tests, benchmarks and demonstrations that need a predictable volume of adjustable size; use wavelet for a smoothly varying scalar field.
  • pvFeatureEdges — Full native Feature Edges: extracts boundary, feature, non-manifold and (optionally) manifold edges of a polygonal surface as polydata lines, with the same classes and ParaView defaults as featureEdges (boundary, feature and non-manifold on, manifold off, FeatureAngle 30°). It also exposes Coloring, which adds a cell array identifying each edge's class so the classes can be coloured or thresholded separately.
  • pvFidesJSONReader — Reads ADIOS2 data through Fides using an explicit Fides data model given as a JSON file, which describes how ADIOS2 variables form coordinates, cells and fields. The data model names one or more data sources, and DataSourcePath tells the reader which BP file or stream each source is. The output is a partitioned dataset collection. ParaView marks this route as mainly for debugging data models; use pvFidesReader when the BP output carries its own Fides metadata.
  • pvFidesReader — Reads ADIOS2 output through the Fides library, which maps ADIOS2 variables to meshes using a data model; for a BP file or BP4/BP5 directory written with Fides metadata the data model is found automatically. The output is a partitioned dataset collection with the selected point, cell and field arrays and the stored time steps. Use it for Fides-annotated simulation output; use pvFidesJSONReader when the data model is a separate JSON file.
  • pvFieldArraysFromFile — Passes its input through unchanged and attaches the field-data arrays found in a legacy VTK file (.vtk, read with vtkDataObjectReader, e.g. a file holding a FIELD section); on a composite input every block receives them. Only field data (whole-dataset values such as run parameters, metadata or small history tables) is added, never point or cell arrays. Use it to carry case metadata alongside a mesh; for per-point or per-cell values join data with another operation instead.
  • pvFieldDatatoAttribute — Copies field-data arrays (one value per dataset, e.g. a time value or a parameter stored by a reader) into point or cell arrays holding that value at every point or cell. Only the first component of the first tuple is used, stored as a constant (implicit) array, so the memory cost is small; string arrays are not supported. Use it to colour, threshold or calculate with dataset-level values alongside the fields.
  • pvFiniteElementFieldDistributor — Turns element-wise finite-element coefficients into point fields for visualization: it duplicates points so each element owns its own nodes, promotes cells to higher-order Lagrange types where needed, and evaluates H(Grad) discontinuous-Galerkin scalars and H(Curl)/H(Div) vector fields at those nodes. Input must be a partitioned dataset collection whose field data has an "Information Records" string array describing bases and fields (Intrepid2 conventions, e.g. Exodus files read with the IOSS reader); the output has the same structure with the distributed point arrays.
  • pvFlashReader — Reads output of the FLASH astrophysics code (HDF5 plot or checkpoint files) into an overlapping AMR (hierarchical box) dataset: nested refinement levels of uniform blocks with cell-centred variables. Level sets the finest level loaded, counted from the root level 0 (ParaView default 1), and every variable starts disabled, so name the ones you need in CellArrayStatus. Several files form a time series. For particles use pvFLASHAMRParticlesReader; to analyse on a uniform grid, follow with pvResampleToImage or pvResampleAMR.
  • pvFluentCFFCaseReader — Reads ANSYS Fluent results in the HDF5-based Common Fluids Format: the case file (.cas.h5) and, automatically, the data file of the same name (.dat.h5). The output is a multiblock dataset of unstructured grids with cell-centred solution fields. Several case files form a time series. Use pvFluentCaseReader for the legacy .cas/.dat format.
  • pvFluentCaseReader — Reads ANSYS Fluent legacy case files (.cas, or .msh mesh files) and the data file whose name replaces the extension with .dat, producing a multiblock dataset of unstructured grids with cell-centred fields. Several case files form a time series. Use pvFluentCFFCaseReader for the HDF5-based .cas.h5/.dat.h5 format.
  • pvForceStaticMesh — Caches the geometry and topology of its input the first time it runs and keeps reusing that mesh for later time steps, updating only point, cell and field data while the point and cell counts stay the same. Use it after readers or filters that rebuild an unchanged mesh at every time step, so that downstream work depending only on the mesh need not be repeated. It handles an unstructured grid, polydata, or the first block of a composite input when that block is an unstructured grid.
  • pvForceTime — Makes its output use one fixed time, ForcedTime (ParaView default 0.0), whatever time the scene requests: the upstream pipeline is updated once at ForcedTime, the result is cached, and every time step it reports is replaced by ForcedTime. Use it to hold a reference state, such as the initial geometry or a chosen snapshot, fixed while the rest of the scene follows the selected times. With IgnorePipelineTime false it passes the input through unchanged.
  • pvFrustumSelectionSource — Creates a frustum selection: everything inside a convex volume bounded by six planes, given by the eight corner vertices in Frustum. This is how ParaView stores a rubber-band selection through a camera view, but any convex hexahedral region (e.g. a box) can be described. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. For an axis-aligned box clip, pvClip with a Box type is often simpler.
  • pvGDALRasterReader — Reads a GIS raster (GeoTIFF, DEM, ERDAS and the other formats supported by GDAL) into a uniform grid (vtkUniformGrid, supporting blanking of no-data pixels) whose bands are cell-data arrays, one cell per raster pixel. Colour bands are by default collated into one RGB, RGBA, grey-alpha or palette array. Use it for terrain heights, satellite images or land-use maps; warp a height band with warpScalar to obtain terrain.
  • pvGDALVectorReader — Reads one layer of a GIS vector file (Shapefile, GeoJSON, KML, GML, DXF and other GDAL vector formats) into polydata: points, lines and polygons with the feature attributes as cell-data arrays. By ParaView default each feature is a separate block of a multiblock dataset; AppendFeatures merges them into one polydata. Use it for outlines, roads, building footprints or measurement locations in GIS formats.
  • pvGaussianCubeReader — Reads a Gaussian Cube file (.cube) produced by the Gaussian quantum-chemistry package. Output port 0 is the molecule (vtkMolecule: atoms and positions) and port 1 the gridded volumetric quantity, such as electron density or an orbital, as image data; select it with {"node": id, "port": 1} for contouring or volume rendering. Use pvXYZReader or pvPDBReader for structures without volumetric data.
  • pvGaussianResampling — Splats the input points into a uniform volume (vtkImageData, point array SplatterValues): each point adds a Gaussian kernel ScaleFactor × value × exp(ExponentFactor × r² / R²) to nearby voxels within radius R, and overlapping contributions are combined by the accumulation mode (ParaView default Max). Without a selected array, or with scale splats off, each point contributes the kernel alone, giving a smooth point-density field. Use it to turn scattered particles or measurements into a continuous field for contouring or volume rendering; use pvResampleToImage to sample an existing mesh instead.
  • pvGenerateGlobalIds — Deprecated alias of pvGlobalPointAndCellIds (renamed in ParaView 5.13, removal planned for 5.14): generates global point and cell ids consistent across blocks and processes and flags duplicated points as ghosts. Prefer pvGlobalPointAndCellIds for new workflows.
  • pvGenerateIds — Deprecated alias of pvPointAndCellIds: ParaView 5.13 marks GenerateIdScalars for removal in 5.14, and it still runs the older vtkIdFilter. It adds zero-based point indices (PointIds) and cell indices (CellIds) as point and cell arrays. Use pvPointAndCellIds or generateIds in new workflows.
  • pvGenerateProcessIds — Deprecated alias of pvProcessIds (ParaView marks GenerateProcessIds deprecated in 5.13, to be removed in 5.14): it adds PointProcessIds and/or CellProcessIds arrays giving the owning MPI process of each point or cell. Prefer pvProcessIds for new workflows; behaviour is the same.
  • pvGenerateQuadraturePoints — Creates a point cloud (polydata with one vertex per quadrature point) from the selected quadrature offset array, carrying as point data the field-data arrays previously interpolated to the same offsets. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud. Use it to view or export quadrature-point values, e.g. for finite-element verification.
  • pvGenerateQuadratureSchemeDictionary — Adds a cell array QuadratureOffset (one offset per cell) whose metadata holds a quadrature-rule dictionary for each cell type, the starting point of ParaView's quadrature workflow. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud. Rules exist only for triangles, quadratic triangles, pixels, quads, quadratic quads, tetrahedra and quadratic tetrahedra.
  • pvGenerateSpatioTemporalHarmonics — Adds a point array SpatioTemporalHarmonics (set as active scalars) whose value at point x and time t is the sum over harmonics of A·sin(k·x + ω·t + φ), with t the requested pipeline time and x in dataset coordinates. It produces analytic, time-varying test fields, e.g. to check interpolation, temporal statistics or FFT workflows against known waves. This is the old name of the same ParaView filter.
  • pvGenerateSurfaceNormals — Deprecated ParaView alias of pvSurfaceNormals: the PolyDataNormals proxy was renamed SurfaceNormals, deprecated in ParaView 5.13 and is scheduled for removal in 5.14. It computes point normals on polygonal surfaces for smooth shading, with exactly the settings and behaviour of pvSurfaceNormals. Prefer pvSurfaceNormals in new documents.
  • pvGenerateSurfaceTangents — Deprecated alias of pvSurfaceTangents: ParaView 5.13 marks PolyDataTangents for removal in 5.14. It computes point tangents (array Tangents) of a triangulated surface from point normals and texture coordinates for normal-map rendering.
  • pvGenerateTimeSteps — Passes its input through unchanged (shallow copy) but declares a new list of time steps (TimeStepValues), ignoring any time steps the input reports. Use it to give static or untimed data a time axis, so temporal filters or time-dependent scenes downstream have steps to work with. It only relabels: a request for one of the new times is passed upstream unchanged, so static input returns the same data at every step and nothing is interpolated.
  • pvGenericIOMultiBlockReader — Reads HACC GenericIO particle files (.gio) into a multiblock dataset with one unstructured-grid block per block stored in the file (usually one per writing MPI rank), vtkPGenericIOMultiBlockReader. Coordinate, array and halo settings work as in pvGenericIOReader. Choose it to keep the file's decomposition, for example to read back pvWriteGenericIOWriter output; use pvGenericIOReader for a single particle grid.
  • pvGenericIOReader — Reads HACC GenericIO particle files (.gio) into one unstructured grid of particles (vtkPGenericIOReader): xAxis, yAxis and zAxis name the coordinate variables, PointArrayStatus chooses the other variables to load, and HalosToLoad with HaloId can restrict reading to particles of chosen halos. Several file names form a time series. Its output suits pvANLHaloFinder; use pvGenericIOMultiBlockReader to keep the file's blocks separate and pvMultiResGenericIO for multi-resolution .gios sets.
  • pvGeometryFilter — ParaView's rendering geometry extractor (vtkPVGeometryFilter): converts any dataset, including composite and nonlinear-cell data, into polydata of its outer surface or, with UseOutline, its bounding outline, adding original cell and point id arrays by default. Representations use it internally; as a pipeline node it is a robust way to get the renderable surface. For an ordinary surface use surface or pvExtractSurface.
  • pvGhostCells — Generates ghost cells and points: layers of neighbouring cells copied from adjacent blocks of a partitioned dataset or from other MPI processes, marked with vtkGhostType. Supported block types are image, rectilinear, structured, polydata and unstructured grids (and hyper tree grids). Use it before filters that need neighbour information across partition boundaries, such as gradients or smoothing, so results do not show seams; remove the layers afterwards with pvRemoveGhostInformation.
  • pvGhostCellsGenerator — Deprecated alias of pvGhostCells (renamed in ParaView 5.13, removal planned for 5.15): generates ghost cell and point layers between partitions and processes. Prefer pvGhostCells for new workflows; the settings are identical.
  • pvGlobalIDSelectionSource — Creates a selection by global ID: the elements whose value in the input's designated global-ID array (point or cell, per FieldType) equals one of GlobalIDs. Global IDs stay the same across MPI decompositions and across composite blocks, so this is the robust way to pick the same nodes or elements in a partitioned mesh. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvIDSelectionSource for plain zero-based indices.
  • pvGlobalPointAndCellIds — Assigns global point and cell ids that are unique across all blocks and MPI processes, giving the same id to points duplicated at block or process boundaries (matched within Tolerance) and marking the duplicates as ghost points. Hyper tree grids get cell ids only. Use it before operations that need consistent ids across partitions, such as ghost generation or merging; for simple local indices use generateIds or pvPointAndCellIds.
  • pvGlyph — Places a copy of a glyph shape (arrow, cone, cube, cylinder, line, sphere or 2-D glyph, GlyphType) at points of the input, or at cell centres when the chosen arrays are cell data, oriented by a vector array and scaled by a scalar or vector array; output is polydata. Use it for velocity arrows or sized markers. Use pvGlyphWithCustomSource to glyph with your own geometry.
  • pvGlyphWithCustomSource — Like pvGlyph, but the glyph geometry is any polydata connected to the GlyphSource input (e.g. a CAD part or a custom marker), placed at points or cell centres, oriented by a vector array and scaled by a scalar or vector array; output is polydata. Use it when the built-in shapes are not enough.
  • pvGradient — Full native Gradient: estimates the gradient of a point or cell array (3 components for a scalar, 9 for a vector), optionally with divergence, vorticity and Q-criterion, and adds them as arrays on the same mesh. Extra settings cover result names, boundary treatment and dimensionality for image data, which neighbouring cells contribute, the value used where no gradient can be computed, a faster approximation, and hyper-tree-grid modes. Use gradient for the common case.
  • pvGradientMagnitude — Computes the magnitude of the spatial gradient of an image's point scalars with central differences that account for the pixel spacing, giving image data of the same size (edge values use one-sided neighbours). It is the classic edge-strength image, useful to locate interfaces or fronts. Dimensionality decides whether the z derivative is included. For gradients of general meshes, or vector results, use gradient.
  • pvGroupDatasets — Combines several inputs into one composite dataset, each input becoming one block: a multiblock dataset by ParaView default, or a partitioned dataset (all inputs as partitions of one block) or partitioned dataset collection. Use it to process, colour or export separate nodes together; use append or merge when you need one merged mesh instead. The curated group is the simpler alternative.
  • pvGroupTimeSteps — Loads every time step of the input and returns them together as one dataset without time: a multiblock if the input is multiblock, otherwise a partitioned dataset collection, with one block per step named timestep0, timestep1, … (zero-based step index, not the time value). Use it to overlay or export all steps at once, e.g. to compare particle positions.
  • pvH5PartReader — Reads H5Part particle files (.h5part, an HDF5 layout used by accelerator and plasma codes) into polydata points with the selected particle arrays; every step stored in the file becomes a time step (time values from the file, or the step index when they are missing). Coordinates come from three scalar arrays chosen by Xarray, Yarray and Zarray (by default the first of x, coords_0, coords0 and so on that exists).
  • pvHDF5RageReader — Reads RAGE simulation output stored in HDF5 through an ASCII descriptor that lists the data files and the type and order of the variables (ParaView registers the .h5rage extension; the native text calls it a .pio file). The output is uniform image data with the selected variables as point arrays, one time step per data file.
  • pvHDRReader — Reads a Radiance HDR image (.hdr, run-length-encoded RGBE or XYZE) into 2-D uniform image data with 32-bit floating-point colour channels, keeping the full dynamic range for analysis or image-based lighting. Use pvPNGSeriesReader or pvTIFFSeriesReader for ordinary 8- or 16-bit images.
  • pvHierarchicalDataIDSelectionSource — Creates an index selection inside an AMR (overlapping AMR / hierarchical box) dataset: each entry names an AMR level, a dataset (box) within that level and a zero-based point or cell index inside that box. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvCompositeDataIDSelectionSource for multiblock data and pvIDSelectionSource for a single non-composite dataset.
  • pvHierarchicalFractal — Test source that builds a refined hierarchy of uniform (or rectilinear) grid blocks around a Mandelbrot-set fractal, with a cell array scaled to look like a material volume fraction (0.5 at FractalValue). It produces a composite, AMR-like dataset and exists to exercise AMR, ghost-level and material-interface filters, not to represent physical data. For an AMR test pulse use pvAMRGaussianPulseSource; for a single-block fractal use pvMandelbrot.
  • pvHistogram — Bins one component (or the magnitude) of one array into equal-width bins and outputs a table with bin_extents (bin centre positions) and bin_values (counts), plus per-bin averages of the other arrays when CalculateAverages is on. Use it to study a value distribution, e.g. of pressure or velocity magnitude over a mesh. Counts are per point or per cell, not weighted by cell size. Use pvHistogram2D for the joint distribution of two variables.
  • pvHistogram2D — Builds a joint (2-D) histogram of two array components and outputs it as a 2-D image (vtkImageData) whose point scalars are the counts: X-variable bins along the image x axis, Y bins along y. By ParaView default the Y variable is the gradient magnitude of the X array, the value-versus-gradient plot used to design volume-rendering transfer functions; turn UseGradientasYAxisArray off to histogram two arbitrary arrays, e.g. temperature against pressure. Both arrays must have the same association and number of tuples. Use pvHistogram for one variable.
  • pvHyperTreeGrid — Builds a hyper tree grid (vtkHyperTreeGrid), a tree-based AMR structure: a rectilinear grid of root cells, each refined recursively by a binary (BranchFactor 2) or ternary (3) subdivision described by the Descriptor string. In the descriptor, levels are separated by "|", "R" marks a refined cell and "." a leaf, e.g. "RR | .R. ... | ...". Use it to construct exact test cases for hyper-tree-grid filters; for random trees use pvHyperTreeGridRandom.
  • pvHyperTreeGridAxisReflection — Mirrors a hyper tree grid (vtkHyperTreeGrid, an adaptively refined tree-based grid) across a plane perpendicular to x, y or z: PlaneNormal picks the axis and PlanePosition the plane's coordinate on it. The output holds only the mirrored grid, unlike pvReflect, which can keep the original too, and cell arrays are copied unchanged. For ordinary datasets use reflect or pvReflect.
  • pvHyperTreeGridCellCenters — Produces a point cloud (polydata) with one point at the centre of each leaf cell of a hyper tree grid; the cell arrays become point arrays on those points. CreateVertexCells (ParaView default true) adds a vertex per point so the points render and count as cells. Use it for glyphs or for sampling HTG data at cell centres; for ordinary meshes use pvCellCenters.
  • pvHyperTreeGridDepthLimiter — Truncates a hyper tree grid at a maximum refinement depth: cells at depth SetDepth become leaves and finer levels are dropped, giving a coarser view of an adaptively refined grid. Depth counts from 0 at the root cells; if it is at least the grid's deepest level, the output equals the input. With a material mask present, ParaView notes that the output extent can be larger than the input's.
  • pvHyperTreeGridEvaluateCoarse — Recomputes the values stored on refined (coarse) cells of a hyper tree grid from their children, for every cell array, with the chosen Operator: Min, Max, Sum, Average (masked children count as Default), Unmasked Average, Elder Child (the first child's value) or Splatting Average; the Don't change options leave coarse values as they are. Leaf values are unchanged. Use it before coarse-level views such as pvHyperTreeGridDepthLimiter so coarse cells summarise their children.
  • pvHyperTreeGridFeatureEdgesFilter — Generates polygonal lines along the feature edges of a hyper tree grid: the grid itself in 1-D, border edges in 2-D, and edges where faces meet at 90 degrees in 3-D, computed while traversing the trees so T-junctions between refinement levels are handled. Use it to outline HTG geometry in images; for ordinary meshes use featureEdges or pvFeatureEdges.
  • pvHyperTreeGridGeometryFilter — Extracts the external surface of a hyper tree grid as polydata: segments for a 1-D grid and faces for 2-D and 3-D grids, cut along material interfaces when the grid carries them, with cell data on the output faces. Use it to render or export an HTG surface; for volume operations convert with pvHyperTreeGridToUnstructuredGrid or pvHyperTreeGridToDualGrid.
  • pvHyperTreeGridGhostCellsGenerator — Generates ghost hyper trees at the interfaces between MPI processes for a distributed hyper tree grid, containing only the interface nodes and leaves. It is needed only in parallel runs before filters that use neighbour (Von Neumann or Moore) super-cursors; a serial run has no process interfaces. For ordinary datasets use pvGhostCellsGenerator.
  • pvHyperTreeGridRandom — Builds a hyper tree grid (vtkHyperTreeGrid) with pseudo-random binary refinement: each node is split with probability SplitFraction down to MaxDepth, a target MaskedFraction of cells is masked, and the root grid spans OutputBounds. A "Depth" cell array records each cell's level. The same Seed reproduces the same tree. Use it to stress-test hyper-tree-grid filters; use pvHyperTreeGrid for an exactly specified tree.
  • pvHyperTreeGridReader — Reads a VTK XML hypertree grid file (.htg): an adaptive tree-based mesh (vtkHyperTreeGrid) in which each coarse cell is refined recursively, typical of AMR codes. MaximumNumberOfLevels limits the refinement depth loaded and BoundingBoxByCoordinates loads only the trees touching a box, both cutting memory and read time. Several files form a time series. Use pvXMLPartitionedHyperTreeGridReader for partitioned .phtg data.
  • pvHyperTreeGridToDualGrid — Converts a hyper tree grid to its dual unstructured grid: one point at the centre of each leaf cell, cells connecting neighbouring centres, and the HTG cell arrays turned into point arrays. The result works with the standard filters (contour, slice, gradient) and gives smooth point-interpolated fields, but uses much more memory than the HTG. Use pvHyperTreeGridToUnstructuredGrid to keep the original leaf cells and cell values.
  • pvHyperTreeGridToUnstructuredGrid — Converts every leaf of a hyper tree grid into an explicit unstructured-grid cell (segments in 1-D, rectangles in 2-D, right hexahedra in 3-D) with the cell arrays kept. The result works with all standard filters but uses much more memory, and cells at different refinement levels meet at T-junctions (hanging nodes), so faces are not conformally connected. Use pvHyperTreeGridToDualGrid for a point-based dual mesh.
  • pvHyperTreeGridVisibleLeavesSize — Adds two double cell arrays to a hyper tree grid: ValidCell, 1.0 for leaves that are neither masked nor ghost and 0.0 otherwise, and CellSize, the cell's volume in 3-D, area in 2-D or length in 1-D, derived from its refinement level. Multiplying a field by both and summing gives a size-weighted total over visible leaves, e.g. the grid's total volume. Run it again if cells are refined afterwards.
  • pvIDSelectionSource — Creates an index selection: points or cells (per FieldType) chosen by their zero-based position in a single, non-composite dataset, each given with the MPI process that owns it. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Indices change whenever the mesh or its decomposition changes; use pvGlobalIDSelectionSource for stable IDs and pvCompositeDataIDSelectionSource for multiblock data.
  • pvIGESReader — Reads a IGES CAD file through OpenCASCADE and tessellates its B-rep faces into triangles, giving a multiblock dataset with one polydata block per shape (named from the file, or Unnamed) and a per-cell Colors array from the CAD colours. LinearDeflection and AngularDeflection set how closely the triangles follow curved surfaces; ReadWire adds edges as polylines. Use it to bring CAD geometry in for rendering, clipping or probing; use pvSTEPReader for .step/.stp, and readSTL or pvSTLReader for already-tessellated STL.
  • pvIOSSCellGridReader — Reads IOSS databases (Exodus, including the discontinuous-Galerkin .exdg variant) into a partitioned dataset collection whose partitions are cell grids (vtkCellGrid), ParaView's representation for higher-order and DG cells with attributes defined per cell type. Use it when cell-grid filters (pvCellGridElevation, pvCellGridProbe) or high-order fields are needed; use pvIOSSReader for ordinary unstructured grids accepted by most filters.
  • pvIOSSReader — Reads Exodus II and CGNS databases through Sandia's IOSS library into a partitioned dataset collection: one partitioned dataset per selected block or set, organized in an assembly by entity type. Spatially partitioned files (name.e.N.r) and restart series (name.e-s.001…) are found automatically. By default all blocks and all fields are read and sets are not. Choose it for finite-element results from Sierra, MOOSE or other Exodus writers; pvExodusIIReader is the older Exodus reader and pvCGNSSeriesReader handles CGNS files IOSS cannot open.
  • pvImageDataToAMR — Converts a uniform image (vtkImageData, at least 2-D) into an overlapping AMR dataset (vtkOverlappingAMR). The input image is the finest level; coarser levels are generated from it with RefinementRatio between consecutive levels, and the hierarchy is split into at most MaximumNumberofBlocks blocks. No resolution is added. Use it to feed AMR operations such as pvExtractAMRBlocks, pvAMRContour or pvResampleAMR from image data.
  • pvImageDataToUniformGrid — Converts image data (vtkImageData, or composite data whose leaves are images) into a vtkUniformGrid with blanking: a single-component point or cell array marks which points or cells are hidden. Values strictly between -1 and 1 (effectively zero) hide the element and other values keep it; Reverse swaps this. The blanking is written as a vtkGhostType array of hidden points or cells, which rendering and blanking-aware filters skip. Use it to mask solid or invalid regions of a regular grid without changing its structure.
  • pvImageDatatoPointSet — Converts uniform image data (vtkImageData) into an equivalent structured grid with explicit point coordinates; point and cell arrays are kept. Use it before operations that move or need explicit points but reject image data, at the cost of storing coordinates.
  • pvImageReader — Reads headerless raw binary voxel files (.raw) into uniform image data. The file carries no metadata, so you describe it: DataExtent (index ranges), DataScalarType, DataByteOrder, NumberOfScalarComponents and FileDimensionality, plus DataSpacing and DataOrigin for world placement. Several files are a time series unless ReadAsImageStack stacks 2-D files as z slices. Use pvNrrdReader or pvMetaFileSeriesReader when a header file exists.
  • pvImageShrink — Reduces the resolution of an image or volume (vtkImageData) by integer factors per axis, either by averaging each block of input pixels (ParaView default) or by keeping every nth pixel. The output spacing grows by the same factors. Use it to make large images manageable for preview or export; use resample or pvResampleToImage for non-integer target resolutions.
  • pvInSituParticlePath — Parallel particle-path (pathline) tracer intended for in-situ use, e.g. inside a Catalyst pipeline that advances with a running simulation. Seeds from SeedSource are advected through the time-varying point vector field of Input; it adds options to clear the particle cache, keep advecting from previously computed particles (RestartSource) after a simulation restart, and start at FirstTimeStep. Output is polydata. For post-processing saved time series use pvParticlePath or pvParticleTracer.
  • pvIntegrateVariables — Integrates every point and cell array over the input cells and sums the total length, area or volume; the output is a single point with one vertex cell holding the results. Only cells of the highest dimension present are used (with lines, triangles and hexahedra mixed, only the hexahedra count) and vertices are ignored. Same native filter as the curated integrate; use it for totals such as a surface-integrated flux or a volume-integrated quantity.
  • pvInterpolatetoQuadraturePoints — Interpolates every point array of the input to the quadrature points of each cell, using the selected quadrature offset array, and stores the results as field-data arrays of the same names (linked to the offset array); the mesh is unchanged. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud.
  • pvIntersectFragments — Intersects material fragments with a plane, box or sphere. Input must be the fragment geometry and Source the fragment statistics (centres), i.e. output ports 0 and 1 of pvMaterialInterfaceFilter. Output port 0 is the intersection geometry and port 1 a point set approximating the centre of each fragment's cut. Use it to measure fragment cross-sections on a cutting surface.
  • pvIsoVolume — Keeps the part of the input where a scalar lies between the two bounds of ThresholdRange (inclusive), cutting cells exactly at both iso-values for point arrays; the output is an unstructured grid. Use it for the volume between two levels, e.g. 0.1 < alpha < 0.9 at a phase interface. Unlike threshold, which keeps or drops whole cells, it produces smooth boundaries.
  • pvJPEGSeriesReader — Reads JPEG images (.jpg, .jpeg) into uniform image data with 8-bit greyscale or RGB point scalars. Several files are stacked into a 3-D volume by default (ReadAsImageStack true); set it false to read them as a time series. JPEG is lossy, so use it for photographs or rendered images rather than quantitative fields; pvPNGSeriesReader or pvTIFFSeriesReader keep exact values.
  • pvKMeans — Clusters observations into k groups (ParaView default 5) in the space spanned by the selected arrays, iterating until cluster centres move less than Tolerance or MaxIterations is reached. The model is the set of centres; assessment labels each point or cell with its nearest cluster and the distance to it, e.g. to segment flow regimes. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.
  • pvLANLFOFSODHaloFinder — LANL cosmology halo finder (vtkPLANLHaloFinder): it groups particles into friends-of-friends halos using a linking length in units of the interparticle spacing and, if SphereOverdensityHalosSOD is on, also computes spherical-overdensity (SOD) halo mass and radius around each large FOF halo. The input must carry point arrays velocity, mass, tag and ghost, as produced by pvCosmoReader. Port 0 returns the particles with a HaloID array; port 1 one point per halo with HaloMass, AverageVelocity, VelocityDispersion and, with SOD, the SOD arrays.
  • pvLSDynaReader — Reads an LS-DYNA d3plot database (the d3plot file and its numbered family files d3plot01, d3plot02… holding later states) as a time series. The output is a multiblock dataset with one unstructured-grid block per selected part, named after the part, carrying nodal arrays (e.g. Velocity, Acceleration) and per-element-type cell arrays (e.g. Stress, EffPlastStrn). Use it for crash, forming and impact results; select parts and arrays to limit memory.
  • pvLegacyParticlePath — Legacy particle-path (pathline) tracer kept for compatibility with older ParaView states: it integrates particles from the SeedSource points through a time-dependent, point-centred velocity field and outputs polydata polylines, one per particle, up to the time at which the node is updated. Use it to follow fluid parcels in unsteady flow. For new work prefer pvParticlePath; for snapshot streamlines use streamTracer.
  • pvLegacyStreakLine — Legacy streakline tracer kept for compatibility with older ParaView states: particles are released from the SeedSource points at every step (reinjection every step by ParaView default) and advected through a time-dependent, point-centred velocity field; the output polydata connects all particles released from the same seed, like dye from a fixed injector. For new work prefer pvStreakLine; use pvLegacyParticlePath to follow individual particles.
  • pvLegacyVTKReader — Reads a legacy-format VTK file (.vtk, ASCII or binary), the older single-file format that can hold structured points (image data), a structured, rectilinear or unstructured grid, or polydata, with point and cell arrays; the output type is whatever the file stores. Several file names form a time series, one file per step. Prefer the VTK XML readers (pvXMLPolyDataReader, pvXMLUnstructuredGridReader, …) for new data; use pvPartitionedLegacyVTKReader for a .pvtk set of pieces.
  • pvLevelScalarsOverlappingAMR — Adds an array named LevelIdScalars holding the refinement level of each block of an overlapping AMR dataset, so refinement levels can be coloured or thresholded. The input must be vtkOverlappingAMR (e.g. from AMR readers); structure is unchanged. This is the old name of the same ParaView filter.
  • pvLine — Creates a straight line from Point1 to Point2 as a polyline with intermediate points: either Resolution equal segments (UseRegularRefinement true, the default) or points at the fractions listed in RefinementRatios. Use it as a probe or seed line, a ruler-like annotation or a reference edge; to sample data along a line use probeLine.
  • pvLinearCellExtrusion — Extrudes every polygon of a polygonal surface independently into a 3-D cell (triangles to wedges, quads to hexahedra, other polygons to polyhedra) by a length equal to a cell scalar times ScaleFactor, along the cell normal or a user vector; the output is an unstructured grid. Use it for 3-D bar maps, e.g. building heights on a footprint map or values drawn as columns on a surface. Use pvLinearExtrusion to sweep the whole surface by one vector.
  • pvLinearExtrusion — Sweeps a polygonal dataset along one vector, creating side faces from its edges and, with Capping, copies of the polygons at both ends; output is polydata. Use it to turn a 2-D outline or planar surface into a prism-like solid surface, e.g. a profile into a constant-thickness part. Use pvLinearCellExtrusion for per-cell heights or volume cells.
  • pvLocationSelectionSource — Creates a location selection from world-space points. With FieldType CELL (the ParaView default) it selects the cells that contain each location; with POINT it selects mesh points located at each location. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. To sample interpolated values at a point instead, use pvExtractLocation or pvProbeLocation.
  • pvLogo — Source that turns a texture resource into image data: it copies the texture's image (vtkImageData) with origin [0, 0, 0] and spacing 1, so pixel indices become coordinates. In ParaView it feeds the logo annotation; in Schemaxis its output can be published or processed like any image. Connect a pvResourceImageTexture or pvResourceTexture node to the Texture input; without one the output is empty.
  • pvLoopSubdivision — Refines a triangle surface with Loop's approximating subdivision: each pass splits every triangle into four and repositions points so the surface becomes smooth; point data are interpolated by the same scheme and new triangles inherit their parent's cell data. Use it to smooth coarse triangulated geometry for display. Input must be polydata of triangles only (run triangulate first). Because points move, the result no longer passes through the original vertices; use pvSubdivide for refinement that keeps the shape.
  • pvMFIXReader — Reads MFIX multiphase-flow results: the restart file (.RES) supplies the cylindrical or rectilinear mesh, converted to an unstructured grid, and the SP* files beside it supply transient cell data, with one time step per stored output. Use it for MFIX gas-solid simulations; fields are cell-centred.
  • pvMPIMoveData — ParaView-internal data-delivery filter that moves polydata, unstructured grids or AMR data between MPI processes and between data server, render server and client: PassThrough leaves data where they are, Collect gathers them to one process and Clone copies them to all. Its output type is PolyData unless OutputDataType says otherwise. It exists for ParaView's rendering pipeline; in Schemaxis prefer pvAppendReduce or pvReductionFilter to gather data.
  • pvMRCSeriesReader — Reads MRC volumes (.mrc, also .st, .rec, .ali), the format of cryo-electron microscopy maps and tomograms, into uniform image data. Several files are read as a time series (one per step); this reader has no stacking option.
  • pvMandelbrot — Generates image data whose float point scalar "Iterations" counts the iterations of z → z² + C before |z| exceeds 2 (capped at MaximumNumberofIterations). The 4-D parameter space (C real, C imaginary, X real, X imaginary, where X is the starting z) is sampled from OriginCX over SizeCX, with ProjectionAxes choosing which three parameters map to the image x, y and z axes. Use it as a synthetic image or volume with fine detail for testing.
  • pvMaskPoints — Reduces a dataset to a subset of its points, output as polydata points (optionally with vertex cells) carrying the point data. By ParaView default it keeps every OnRatio-th point by point id (2), starting at Offset, until MaximumNumberofPoints (5000) is reached; random modes instead draw a random or spatially uniform sample. Use it to thin points before glyphs (arrows) or for lighter scatter exports.
  • pvMaterialInterfaceFilter — Finds material fragments in AMR (hierarchical box) data such as CTH Spy Plot output: cells whose material fraction exceeds MaterialFractionThreshold are connected into fragments, whose surfaces form output port 0 (geometry) and whose centres of mass, volumes, masses and selected weighted averages form a point set on port 1 (statistics). It can invert the fraction and clip with a plane or sphere to measure craters, and can write both outputs to text files. Use pvRectilinearGridConnectivity for rectilinear multiblock data.
  • pvMedian — Replaces each pixel or voxel of an image by the median of the selected array over a rectangular neighbourhood of KernelSize pixels, giving image data of the same size. Unlike a mean filter it removes isolated outliers (salt-and-pepper or shot noise) while keeping sharp edges. Each component is filtered separately. Near the image border the neighbourhood is clipped to the image.
  • pvMergeBlocks — Full native Merge Blocks: appends the leaf datasets of a composite input into one dataset. OutputDataSetType decides the result: Unstructured Grid (ParaView default) merges blocks of any type, Polygonal Mesh merges only polydata blocks and leaves others out. MergePartitionsOnly keeps the block hierarchy and merges only the partitions within each block. Use merge for the common case (merge everything with point merging); use this when you need polydata output, a merge tolerance or partition-only merging.
  • pvMergeTime — Combines several time-dependent inputs into one multiblock dataset (one block per input) whose time steps are the union of the inputs' times, or their intersection with Intersection on, with near-duplicates removed using Tolerance. For each requested time, every input supplies the matching step within tolerance, otherwise its last step before that time. Use it to view or export sources with different output times together.
  • pvMergeVectorComponents — Combines three single-component arrays of the same association (e.g. Ux, Uy, Uz from a solver that writes components separately) into one 3-component vector array named OutputVectorName; the dataset is otherwise unchanged. Use it before operations that need a vector field, such as glyphs, stream tracing or vorticity.
  • pvMeshQuality — Adds a cell array Quality rating the shape of each cell with a Verdict metric chosen per cell type (triangle, quad, tetrahedron, pyramid, wedge, hexahedron); other cell types get 0. Use it to locate distorted or degenerate cells before a simulation or to explain solver problems. Each metric has its own scale and ideal value (for example Scaled Jacobian is 1 for an ideal element and negative for inverted ones), so read thresholds from the Verdict documentation. ParaView's defaults are Radius Ratio (triangles, tetrahedra), Edge Ratio (quads, wedges), Shape (pyramids) and Maximum Aspect Frobenius (hexahedra). Use pvCellSize or cellSize for cell size.
  • pvMetaFileSeriesReader — Reads MetaImage files (.mhd header with a separate data file, or single-file .mha), common in ITK-based medical imaging and segmentation, into uniform image data; dimensions, spacing, origin and element type come from the header. Several files form a time series. pvWriteMetaImageWriter writes this format.
  • pvMinMax — Computes, for every point and cell array of the input, the componentwise minimum, maximum or sum over all tuples, and outputs a polydata with exactly one point and one vertex cell that carries the results under the original array names. Use it for one-number summaries such as peak temperature. In parallel runs ghost arrays are needed to avoid double counting. For cell-size-weighted totals use integrate; for distributions use pvHistogram.
  • pvMinkowskiFilter — Computes Minkowski functionals and shapefinders for each polyhedral cell of a Voronoi tessellation (vtkMinkowskiFilter). It adds cell arrays S (surface area), V (volume, copied from the input's Volumes array), C (integrated mean curvature), X (Euler characteristic), G (genus), T = 3V/S (thickness), B = S/C (breadth), L = C/(4 pi (G + 1)) (length), and planarity P and filamentarity F, which characterize whether a structure is sheet-like or filament-like. Use it on merged Voronoi regions from pvVoronoiMergeConnected.
  • pvMoleculeToLines — Converts a molecule (vtkMolecule) into polygonal data: each atom becomes a point and each bond a two-point line cell, with atom data copied to point data and bond data to cell data. Use it to process or export molecular structure with ordinary geometry operations, e.g. pvTube for stick models or a polydata writer. It reverses pvConvertIntoMolecule with line conversion on.
  • pvMotionFXCFGReader — Reads a MotionFX .cfg motion definition: rigid-body motions (such as translation, rotation or planetary motion) applied to STL bodies listed in the file. The output is a temporal multiblock dataset with one block per body, positioned at each generated time step; TimeResolution sets how many steps cover the motion's time range. Use it to animate machine parts, e.g. gears or mixers, alongside simulation results.
  • pvMultiResGenericIO — Reads a multi-resolution set of HACC GenericIO files described by a JSON .gios file (vtkPMultiResolutionGenericIOReader). The file lists levels, each with time steps mapping times to GenericIO files; level 0 is the coarsest. The output is a multiblock with one block per level; without a streaming view requesting finer blocks only level 0 is loaded. Use pvGenericIOReader for a single resolution.
  • pvMulticorrelativeStatistics — Computes the mean vector and covariance matrix (with its Cholesky decomposition) of the selected arrays, i.e. a multivariate Gaussian model, and assesses each observation by its squared Mahalanobis distance from the mean, useful for outlier detection across several correlated fields. Use pvPrincipalComponentAnalysis to add eigen-decomposition. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.
  • pvNek5000Reader — Reads Nek5000 spectral-element results through a .nek5000 metadata file that names the field-file template and the time steps. The output is an unstructured grid built from each spectral element's nodal points, with the selected fields as point arrays. Each element keeps its own copy of points shared with its neighbours unless MergePointstoCleangrid is enabled. This is a distributed reader.
  • pvNetCDFCAMreader — Reads Community Atmosphere Model (CAM) output on an unstructured horizontal grid from two NetCDF files: FileName holds the points and fields and ConnectivityFileName the cell connectivity. The output is an unstructured grid that is unstructured horizontally and layered vertically: quadrilaterals for one layer, hexahedra when several layers are read. VerticalDimension chooses single-layer, midpoint (lev) or interface (ilev) variables; ParaView's default is midpoint layers. Use pvNetCDFReader for CF-convention gridded files.
  • pvNetCDFMPASreader — Reads one MPAS (Model for Prediction Across Scales) NetCDF file on a global unstructured Voronoi mesh and builds its dual grid as an unstructured grid: MPAS cell variables become point data and vertex variables become cell data. By default it shows vertical level 0 on a sphere as ocean data; options give a multilayer view, a lat/lon projection or atmospheric layering. Edge-centred data and regional (planar) domains are not supported, and it is not a parallel reader.
  • pvNetCDFPOPreader — Reads Parallel Ocean Program (POP) NetCDF output into a rectilinear grid. The NetCDF x, y, z order becomes the grid's z, y, x order, and z coordinates are negated so the first level is the highest (depth downwards). Only three-dimensional variables are offered; Stride subsamples the grid. Use pvNetCDFReader for general CF-convention files and pvParallelNetCDFPOPreader for the parallel variant.
  • pvNetCDFReader — Reads NetCDF files using the CF (and COARDS) conventions into structured VTK data: image data when nothing else is known, or rectilinear or curvilinear grids when CF coordinate metadata describes them; latitude/longitude grids can be shaped as a sphere (SphericalCoordinates). Dimensions chooses which group of variables (those sharing a dimension list) is loaded, and time comes from the CF time coordinate. Use it for climate, weather and ocean gridded data; use pvNetCDFCAMreader, pvNetCDFMPASreader or pvNetCDFPOPreader for those models' specific layouts.
  • pvNetCDFUGRIDreader — Reads a NetCDF file that follows the UGRID conventions for unstructured meshes (used by some ocean, coastal and climate models) into an unstructured grid. vtkNetCDFUGRIDReader reads one 2-D mesh: mesh nodes become points and faces become cells (edges are not read), node variables become point arrays and face variables cell arrays, and a "time" variable provides time steps. Use pvNetCDFReader for CF-convention gridded NetCDF, pvNetCDFMPASreader for MPAS meshes or pvNetCDFPOPreader for POP ocean grids.
  • pvNetworkImageSource — ParaView-internal source that reads an image file on one process and makes the image available on the client and render-server processes, used for textures and background images. In ReadFromMemory mode it instead fetches an image registered under TrivialProducerKey on the server. It is not a general network download. To read image data for analysis use readImageData or a pv image reader such as pvPNGSeriesReader.
  • pvNormalGlyphs — ParaView's compound Normal Glyphs filter: extracts the outer surface, computes one normal per surface cell, and draws an arrow glyph at every cell centre along that normal. The output is polydata of arrows, typically rendered over the surface to check normal orientation, e.g. before extrusion, offsets or boundary-condition assignment. Arrow length is the glyph scale factor in dataset units; all arrows have the same size.
  • pvNrrdReader — Reads NRRD images (.nrrd, or a detached .nhdr header with its data file or files) into uniform image data, taking dimensions, type and spacing from the header. vtkNrrdReader reads raw, ascii (also spelled txt or text) and gzip-compressed (gzip or gz) data; hex and bzip2 encodings are rejected with 'Unsupported encoding'. A detached header may name several data files only when each holds one 2-D slice of a 3-D volume. DataVOI loads a sub-box of a large volume.
  • pvOMETIFFChannelCalculator — Combines up to ten fluorescence-microscopy channels of an OME-TIFF image into one RGBA colour image. Each enabled point array named Channel_1 to Channel_10 (the names pvOMETIFFReader produces) is mapped through its ChannelNLUT lookup table, its opacity is multiplied by ChannelNWeight, and the channels are blended additively into a new unsigned-char point array named Colors; the input image and its arrays are passed through unchanged. Use it to make a false-colour composite for display or PNG export; the channel data themselves are not modified.
  • pvOMETIFFReader — Reads an OME-TIFF microscopy file (.ome.tif, .ome.tiff), using its OME-XML metadata to split the TIFF pages into z-planes, channels and time steps; the output is uniform image data with time steps. Only single-file, multi-page OME-TIFF is supported. Use pvOMETIFFChannelCalculator downstream to combine channels, or pvTIFFSeriesReader for plain TIFF.
  • pvOMFReader — Reads an Open Mining Format (.omf) project into a partitioned dataset collection with one entry per selected element: point sets (e.g. drill-hole samples), line sets, surfaces and block-model volumes, with their attribute data. Use it for geological and mining models. Elements are not loaded unless selected in DataElements.
  • pvObjectFileFormatOFFReader — Reads Object File Format geometry (.off: vertex list followed by polygon faces) into polydata with polygons and lines. Use it for meshes from geometry-processing tools; for CAD surfaces in STL or OBJ use readSTL/pvSTLReader or pvWavefrontOBJReader.
  • pvOctreeImagetoPointSet — Reverses pvPointSetToOctreeImage: reads an image whose cell scalars are the unsigned-char "octree" bit mask and emits polydata with one point for every set bit, placed at the centre of the corresponding octant of the cell (a quarter of the spacing from the cell centre). It can also copy one component of a chosen cell array to the generated points. Use it to rebuild an approximate point cloud from a compact octree image; positions are quantized to octants, so original coordinates are not recovered.
  • pvOpenFOAMReader — Full native OpenFOAM reader: opens a case through its .foam marker and outputs a multiblock dataset with the selected mesh regions (internalMesh, patches, patch groups, Lagrangian clouds and optionally zones) carrying cell, point and Lagrangian fields for each stored time. Omitted settings keep ParaView's own defaults: Reconstructed Case, the 0 directory skipped, point data interpolated from cell fields, 32-bit labels and 64-bit scalars. Use the curated foam operation for the common case (decomposed case, internalMesh only, 0 kept); use this one for point or Lagrangian fields, zones, binary label/scalar sizes and the other native options.
  • pvOpenVDBReader — Reads an OpenVDB (.vdb) file, the sparse volume format used in visual effects and some simulation tools. Each grid becomes a block of a partitioned dataset collection: volume grids become image data (vtkImageData) and point grids become polydata vertices. MergeImageVolumes or MergePointSets instead combine the selected grids into one image (one array per grid) or one point set, and DownsamplingFactor coarsens the sampled volume.
  • pvOutline — Produces the 12 edges of the input's axis-aligned bounding box as polydata lines, a lightweight frame for images of volumes or point clouds; in MPI runs the global bounds are used. Same native filter as the curated outline (neither has options). Accepts datasets and graphs; use pvOutlineCorners to draw only the corners.
  • pvOutlineCorners — Draws only the corners of the input's axis-aligned bounding box, as short segments running from each corner along the three box edges, for a less cluttered frame than pvOutline. CornerFactor sets each segment's length as a fraction of the box size along that axis.
  • pvOutlineCurvilinearDataSet — Draws the 12 boundary edges of a structured (curvilinear) grid as polydata lines that follow the grid's curved outer edges instead of its axis-aligned bounding box. Input must be a vtkStructuredGrid. Use it to show the extent of a body-fitted CFD block; outline or pvOutline draw a bounding-box outline of any dataset.
  • pvOutlineSource — Creates the twelve edges of an axis-aligned box as line polydata from explicit Bounds [xmin, xmax, ymin, ymax, zmin, zmax]. Use it to draw a region of interest or a fixed reference box in a scene; to outline the bounds of existing data use outline, and for a solid box use pvBox.
  • pvOverlappingAMRLevelIds — Adds an array named LevelIdScalars holding the refinement level of each block of an overlapping AMR dataset, so refinement levels can be coloured or thresholded. The input must be vtkOverlappingAMR (e.g. from AMR readers); structure is unchanged.
  • pvOverlappingCellsDetector — Detects cells that overlap other cells of the same mesh and adds a cell array, NumberOfOverlapsPerCell, counting for each cell how many other cells it collides with (the upstream description's name NumberOfCollisionsPerCell is outdated). Use it as a mesh-quality check, e.g. for overlapping overset regions or badly merged parts; zero everywhere means no overlap was found. It accepts point sets and composite data and works across MPI processes.
  • pvPCANormalEstimation — Estimates a normal at every point of a polydata point cloud by principal component analysis: a plane is fitted to each point's neighbours and its normal is stored in the point array PCANormals. Use it for scanned or particle data without connectivity, where surface normals cannot be computed from polygons (use normals or pvGenerateSurfaceNormals for meshed surfaces). The neighbourhood is chosen by SearchMode, SampleSize and Radius; the sign of each normal is arbitrary unless NormalOrientation fixes it.
  • pvPDALReader — Reads LiDAR and other point-cloud files through the PDAL library (LAS/LAZ, PCD, PLY, text and the other formats PDAL supports) into polydata points with per-point attribute arrays such as Intensity, Classification and colour. Use it for terrain, building or vegetation scans; follow it with pvPCANormalEstimation or pvGaussianResampling to derive normals or density fields.
  • pvPDBReader — Reads a Protein Data Bank file (.pdb) of macromolecular structure into polydata: atoms as points with arrays such as atom_type, residue, chain and secondary_structures, and bonds as lines estimated from atomic distances. Recent VTK sources also provide a vtkMolecule on output port 1. Use it for protein or nucleic-acid structures; pvXYZReader suits simple coordinate lists.
  • pvPIOReader — Reads xRAGE PIO dump files (Los Alamos radiation-hydrodynamics code) through an ASCII .pio file describing the dump directory, cycles and variables. AMR data become an unstructured grid of cells or, with UseHyperTreeGridHTGforAMRMesh, a hypertree grid; the selected variables are cell arrays. LoadTracers adds tracer particles as a second unstructured grid, and TimeArray chooses the field used as time (ParaView default SimulationTime). This is a distributed reader.
  • pvPLOT3DMetaFileReader — Reads a PLOT3D case through a .p3d meta file: a small JSON file naming the grid (.xyz), solution (.q) and optional function files for each time value, and recording the format settings PLOT3D files do not describe themselves (binary or ASCII, byte order, precision, multi-grid, Fortran byte counts, blanking, 2-D, R, gamma, derived functions). The output is a multiblock dataset of structured grids. Use it for time series or to keep format settings with the data; use pvPLOT3DReader to set the format in the node instead.
  • pvPLOT3DReader — Reads NASA PLOT3D structured-grid data: a grid file (.xyz) with block coordinates, solution files (.q) holding density, momentum and stagnation energy, and a function file (.f) of extra variables. The output is a multiblock dataset of structured grids with density, momentum and stagnation energy as point arrays; Functions adds derived quantities (pressure, Mach number, velocity, vorticity …) computed with the reader's gas constants R = 1.0 and γ = 1.4, which are not exposed here. Several .q files form a time series. Use pvPLOT3DMetaFileReader when a .p3d meta file describes the case.
  • pvPLYReader — Full native PLY reader: reads Stanford PLY polygon files (ASCII or binary) into polydata. ParaView's documentation requires vertex elements with x, y and z and face elements with vertex_indices; further vertex properties such as normals, colours or texture coordinates are carried along as arrays. Several file names form a time series. Use readPLY for one file; use this operation for file series or the texture-coordinate settings.
  • pvPNGSeriesReader — Reads PNG images (.png) into uniform image data with 8- or 16-bit, 1 to 4 component point scalars. Several files are stacked into a volume by default (ReadAsImageStack true), e.g. a segmentation-mask stack; set it false to read them as a time series. PNG is lossless, so values are exact; pair with pvWritePNGWriter for round trips.
  • pvPTSReader — Reads an ASCII PTS point cloud (.pts: point count, then x y z [intensity [r g b]] per line), as produced by laser scanners, into polydata with one vertex cell holding all points and Intensities and Color arrays when present. Optional limits subsample the file to a maximum number of points and/or keep only points inside a box. Use pvPDALReader for LAS/LAZ point clouds.
  • pvPVDReader — Reads a ParaView .pvd collection: an XML index listing VTK XML data files (.vtu, .vtp, .vti, .vtm, .vtt …) with timestep, part and group attributes. Distinct timestep values become a time series; several parts at one time are combined into a composite (multiblock) output. Use it to reopen results written by pvWriteXMLPVDWriter or by solvers that emit .pvd; for a single VTK XML file use the matching reader such as pvXMLUnstructuredGridReader.
  • pvPVTrivialProducer — ParaView's trivial producer (vtkPVTrivialProducer) wraps an existing data object and can also report time steps and a whole extent for structured data split across processes. As with pvTrivialProducer, the data must be attached by native code, which Schemaxis input cannot do, so it is not a useful authoring operation.
  • pvPVTrivialProducer2 — A second registration of ParaView's vtkPVTrivialProducer without the WholeExtent property, used internally by ParaView. It needs a data object attached from native code, which Schemaxis input cannot provide, so it is not useful in an authored workflow; use pvPVTrivialProducer's documentation for context and a reader for real data.
  • pvParallelNetCDFPOPreader — Reads Parallel Ocean Program (POP) output stored in NetCDF (.pop.ncdf, .pop.nc) into a rectilinear grid, with only some MPI processes reading the file and sending the data to the others. ParaView marks this proxy mpi_required, so it is meant for runs with several ranks; for serial runs use pvNetCDFPOPreader. VariableArrayStatus selects the ocean variables and Stride subsamples the grid.
  • pvParticlePath — Advects particles from the seed points (SeedSource port) through a time-varying vector field (Input port) and outputs pathlines: polylines tracing each particle from injection up to the requested time, with arrays such as ParticleId, ParticleAge and InjectionStepId. It integrates through the input's time steps from the first, so later scene times cost more. Use it for unsteady flows where instantaneous streamlines mislead; pvParticleTracer returns only current positions and streamTracer instantaneous streamlines.
  • pvParticleTracer — Advects particles from the seed points (SeedSource port) through a time-varying vector field (Input port) and outputs, at the requested time, only the current particle positions as points with attributes such as ParticleId and ParticleAge; no paths are kept and no cells are created. ForceReinjectionEveryNSteps releases new particles periodically for a continuous stream. Use it to animate particle clouds in unsteady flow; pvParticlePath keeps trajectories.
  • pvParticlesReader — Reads simple particle files (text or binary records of x, y, z and an optional scalar, as float or double) into polydata points with vertex cells and, when HasScalar is true, one scalar point array. Several files form a time series. Use it for raw particle dumps; for structured text tables use pvCSVReader followed by pvTableToPoints.
  • pvPartitionBalancer — For partitioned data (vtkPartitionedDataSet or collections), makes every MPI process hold the same number of partitions by adding empty (null) partitions, and drops empty input partitions. Squash (ParaView default) pads only up to the largest per-process count; Expand gives every non-empty partition its own global index, so partition n exists on exactly one process. Data and geometry are unchanged. Use it before writers or filters that expect a consistent partition layout; in a serial run it only removes empty partitions.
  • pvPartitionedDataSetCollectionSource — Generates a vtkPartitionedDataSetCollection of up to 12 parametric surfaces (Boy, Cross Cap, Figure-8 Klein, Klein, Mobius, Roman, Conic Spiral, Dini, Ellipsoid, Enneper, Super Toroid, Torus, in that order), shifted 2.5 units apart along x, each split into partitions and grouped in a data assembly by orientability. Point arrays "ObjectId" and "PartitionId" identify shape and partition. Use it to test how pipelines handle partitioned collections and assemblies.
  • pvPartitionedLegacyVTKReader — Reads a partitioned legacy VTK data set: a .pvtk summary file listing several legacy .vtk piece files (structured points, structured, rectilinear or unstructured grid, or polydata), which are read as one data set. Use it for older parallel outputs; use pvLegacyVTKReader for a single .vtk file and the XML partitioned readers (e.g. pvXMLPartitionedUnstructuredGridReader) for .pvtu or .pvtp data.
  • pvPassArrays — Generated binding of ParaView's Pass Arrays: keeps only the selected arrays of each association (point, cell, field, and for graphs and tables vertex, edge and row data) and removes the rest, with geometry unchanged. An association whose list is empty passes none of its arrays. Unlike the curated passArrays, omitted lists are not set by Schemaxis, so ParaView's own initial selection applies; name every list whose arrays matter.
  • pvPassThrough — Returns its input unchanged (vtkPassThrough), for any non-composite dataset. It is useful as a named, stable connection point in a workflow, e.g. to give a reader's output a second node id or to separate a branch for publication; it computes nothing.
  • pvPedigreeIDSelectionSource — Creates a pedigree-ID selection: elements whose value in the input's designated pedigree-ID array matches the given IDs, which are integers (PedigreeIDs) or strings (PedigreeStringIDs), each paired with a domain name. Pedigree IDs identify where an element came from (e.g. a source-file element number) and survive filtering. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvGlobalIDSelectionSource for global IDs.
  • pvPerlinNoise — Adds a point array (default name PerlinNoise) of deterministic Perlin noise evaluated at each point's coordinates, varying between -|Amplitude| and |Amplitude|; geometry is unchanged. Use it to generate smooth pseudo-random test fields, perturb geometry together with a warp, or add texture for rendering. The same coordinates and settings always give the same values.
  • pvPhastaReader — Reads results of the PHASTA parallel CFD solver through its .pht meta-file, an XML description of the geometry and field files per time step and partition. The output is a multipiece dataset of unstructured grid pieces with the solver's fields and time steps. Use it only for PHASTA output.
  • pvPlane — Creates a flat parallelogram as polydata: Origin is one corner, and the edges run from Origin to Point1 (the plane's x axis) and from Origin to Point2 (its y axis), subdivided into XResolution × YResolution quadrilaterals. Use it as a seed or probe surface, a sampling plane or reference geometry. The curated plane operation offers the same source with Schemaxis defaults.
  • pvPlotData — ParaView's Plot Data: passes any data object through unchanged (vtkPassThrough) while tagging it for display in a line chart (XYChartView), where ParaView plots its arrays against point or row index. In Schemaxis the data result is the unchanged input; the chart is only a ParaView view preference.
  • pvPlotDataOverTime — Builds time histories by updating the input at every time step it reports and collecting one attribute association (FieldAssociation: Points by ParaView default, Cells, Vertices, Edges or table Rows). Output is a multiblock of tables with a time column: by default one table of per-step statistics (minimum, maximum, quartiles and, for numeric arrays, mean and standard deviation) per input block, otherwise one table per tracked point or cell. Use it for convergence or transient monitoring of a region already reduced to what matters (a probe, slice or clipped zone).
  • pvPlotGlobalVariablesOverTime — Extracts global (field-data) quantities over time into a table with one row per time step, e.g. Exodus global variables such as total energy or time-step size. With AutoDetectGlobalTemporalDataArrays (ParaView default true), arrays flagged as Exodus global temporal variables are used if any exist; otherwise every single-tuple field-data array is collected by updating the input at each time step.
  • pvPlotOnIntersectionCurves — ParaView's compound filter that extracts the outer surface of the input, cuts it with an implicit function (SliceType, a plane by default) and orders the resulting intersection edges into polylines. The output is a multiblock of polylines carrying the interpolated point data plus an arc_length array, suitable for line plots of a field along the curve, e.g. pressure around an aerofoil section. Use pvPlotOverLine or probeLine to sample along a straight segment through the volume instead.
  • pvPlotOnSortedLines — Takes polydata made of line segments, for example the lines produced by slicing a surface, and reassembles them into continuous, ordered polylines, adding an arc_length point array measured along each one. The output is a multiblock dataset with one block per continuous segment, suitable for line charts of a field against distance along an intersection curve. Use pvPlotOnIntersectionCurves to slice and sort in one step, or probeLine / pvPlotOverLine to sample along a straight line instead.
  • pvPlotOverLine — Samples all point and cell arrays of the input along the straight segment Point1-Point2 and returns a polyline (polydata) with the interpolated values plus arc_length and vtkValidPointMask point arrays, ready for line charts or CSV export. SamplingPattern chooses uniform samples (ParaView default, Resolution 1000) or exact cell-boundary or one-per-cell sampling. Composite inputs give a single non-composite line. Use probeLine for the same filter with Schemaxis defaults, and pvResampleToLine for a coarse uniform resampling.
  • pvPlotOverLinesFromCustomSource — Samples the Input dataset along every line or polyline cell of the Source (polydata or an unstructured grid of lines, e.g. extracted feature edges or a polyline source), interpolating point data and taking cell data from the containing cell. Output is a multiblock with one polydata block per source cell, points ordered along the line. SamplingPattern chooses uniform samples (ParaView default, Resolution 1000), samples at cell boundaries (step profiles of cell data) or one sample per crossed cell. Use pvPlotOverLine or probeLine for a single straight line.
  • pvPlotSelectionOverTime — Extracts the points or cells chosen by a selection (the Selection input, e.g. from pvIDSelectionSource or pvLocationSelectionSource) at every time step and reports their values over time. Output is a multiblock of tables with a time column: by ParaView default one table of statistics over the selected elements per step, otherwise one history per element. Location selections take values from the cell containing each location.
  • pvPointAndCellIds — Adds integer arrays with each point's zero-based index (PointIds, point data) and each cell's index (CellIds, cell data) as numbered in this dataset; hyper tree grid input gets cell ids only. The arrays travel with points and cells through later extraction, so they can trace results back to the original elements. generateIds is the curated alternative.
  • pvPointDatasetInterpolator — Interpolates the point arrays of a point cloud (Input: any point set, e.g. particles, scattered measurements or the points of a mesh) onto the points of a second dataset (Source), weighting nearby cloud points with a kernel. The output keeps Source's type, points and cells and adds the interpolated arrays, so a slice, image or mesh can be coloured by cloud data. Kernels range from Voronoi (nearest point, the ParaView default) to smooth Gaussian or Shepard weighting. Use resample when the data live on a mesh with cells, and pvSPHDatasetInterpolator for SPH particles.
  • pvPointDatatoCellData — Converts point arrays to cell arrays by averaging, for each cell, the values at its points; with CategoricalData the most frequent value among the cell's points wins instead, which suits integer labels. The output is the same dataset type with new cell arrays, and by ParaView default the point arrays are dropped. Use it when a step needs cell data, e.g. per-cell statistics or cell-based thresholds; pointToCell is the curated version, and cellToPoint or pvCellDatatoPointData go the other way.
  • pvPointLineInterpolator — Interpolates point data from a point cloud (Input) onto a high-resolution straight line set in the Source options (Point1, Point2, Resolution; ParaView default 1000 intervals), producing a polyline profile for line plots. Use it for profiles through scattered or particle data; for data on a mesh with cells, probeLine samples by cell interpolation instead.
  • pvPointPlaneInterpolator — Interpolates point data from a point cloud (Input) onto a bounded plane set in the Source options (a plane through Center with Normal, limited to BoundingBox plus Padding and refined by Resolution or CellSize), producing a planar grid with interpolated arrays, e.g. a heat-map section through particle or scattered data. For meshes with cells, use slice or resample instead.
  • pvPointSetToOctreeImage — Bins a point set (point cloud or any vtkPointSet) into a uniform image covering the points' bounding box, sized so that each cell holds about NumberOfPointsPerCell points. The output (a partitioned dataset containing one image) has an unsigned-char cell array "octree" whose eight bits record which octants of each cell contain points, and optionally a float cell array, named after a chosen single-component point array, with per-cell last value, min, max, count, sum and/or mean components. Use it to voxelize particle or LiDAR data, or with pvOctreeImagetoPointSet as a compact, lossy point-cloud encoding.
  • pvPointSource — Creates a cloud of NumberOfPoints points placed pseudo-randomly with uniform density inside a sphere of radius Radius around Center, as polydata vertices. Use it as a seed cloud for streamlines or particle tracing, or as test input. With the ParaView defaults (one point, radius 0) it yields a single point at the centre.
  • pvPointVolumeInterpolator — Interpolates point data from a point cloud (Input) onto a bounded volume set in the Source options (Origin, Scale, Padding and Resolution or CellSize), producing image data that can be contoured, sliced or volume-rendered. Use it to turn scattered or particle data into a regular grid; the grid resolution and the kernel radius together set how smooth the result is.
  • pvPolyLineSource — Creates one polyline through an ordered list of points, optionally closed into a loop. Use it for seed curves, measurement paths, outlines or probe paths that are not straight; for a straight subdivided line use pvLine, for a smooth curve through control points use pvSplineSource.
  • pvPolyPointSource — Creates polydata containing exactly the points you list, as vertices with no connectivity between them. Use it to place probe or seed locations at known coordinates (e.g. sensor positions) or to mark points in a scene; for random clouds use pvPointSource.
  • pvPolylineLength — Adds a point array named arc_length holding, at each point of a polyline, the distance travelled along that polyline from its first point; points of other cell types get 0. The output is the same polydata. Use it after probeLine, a streamline or a contour to plot values against distance along the curve.
  • pvPrincipalComponentAnalysis — Extends pvMulticorrelativeStatistics with the eigenvalues and eigenvectors of the covariance matrix (optionally normalized, or robust using medians), and assesses data by projecting each observation onto the principal components, using the full basis, a fixed number of components or enough components to reach a fixed energy fraction. Use it to find dominant correlated modes among several fields or to reduce their dimensionality. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.
  • pvProbeLocation — Samples the input dataset at the points of a probe point cloud (ProbeType; ParaView 5.13.3 offers only the fixed-radius point source) and outputs those points as polydata with interpolated point data, the containing cell's cell data and a vtkValidPointMask array marking points that fell inside the data. Use it for values at a monitor location, and pvPlotDataOverTime after it for a time history. Use probeLine or pvPlotOverLine for profiles.
  • pvProcessIdScalars — Adds an array named ProcessId holding the MPI rank that owns each point (or each cell with CellScalars), so partitioning and load balance can be coloured. In a serial run every value is 0. ParaView deprecated this filter in 5.12 (removal planned for 5.14) in favour of Process Ids; use pvProcessIds in new documents.
  • pvProcessIds — Adds arrays recording which MPI process owns each point (PointProcessIds) and/or cell (CellProcessIds); hyper tree grids get only cell ids. Geometry is unchanged. Use it to visualize or debug the domain decomposition of a parallel run; in a serial run every value is 0.
  • pvProtractor — ParaView's protractor: a polyline (vtkPolyLineSource) through three points, [point 1, vertex, point 2], whose angle at the vertex ParaView's interactive widget displays. In Schemaxis the output is only the polyline geometry; the angle is not written into the data, so compute it from the three points when you need the value. Use it to show an angle annotation in a scene; pvRuler is the equivalent for distances.
  • pvQuadricClustering — Simplifies a polygonal surface by spatial binning: the bounding box is divided into NumberofDimensions bins, all points in a bin collapse to one representative point chosen to minimize quadric error, and degenerate triangles are dropped. It is fast enough for huge meshes (ParaView uses it for level-of-detail rendering), but the result follows the bin grid rather than surface features. Use pvDecimate or decimate when shape fidelity matters more than speed.
  • pvRTXMLPolyDataReader — Real-time VTK XML polydata reader (vtkRTXMLPolyDataReader): it can watch a data directory (Location, optional) for .vtp files arriving from a running simulation; each run of its UpdateToNextFile command reads the next unprocessed file, and ResetReader rescans the directory. FileName names the polydata file read first. Schemaxis declares both commands for onVisit, but a batch run sees only the files present while it runs; use pvXMLPolyDataReader for a fixed file or series.
  • pvRandomAttributes — Adds random-valued arrays to a dataset, composite dataset or hyper-tree grid: point and/or cell scalars (1 component) and vectors (3 components) of the chosen DataType, each component drawn between the two ComponentRange values. By ParaView default only cell vectors of unsigned char in [0, 255] are generated. Generated arrays become the active attributes. Use it for test data or to colour blocks distinctly (AttributesConstantPerBlock).
  • pvRandomVectors — Adds a point array BrownianVectors of random 3-D vectors (random direction, length drawn between MinimumSpeed and MaximumSpeed) and makes it the active vectors; existing vectors are not copied as active. Output has the input's type. Use it for test vector fields or to jitter points with a warp.
  • pvRectilinearDatatoPointSet — Converts a rectilinear grid (axis-aligned with per-axis coordinate arrays) into an equivalent structured grid with explicit point coordinates; arrays are kept. Use it before operations that need explicit points or reject rectilinear grids.
  • pvRectilinearGridConnectivity — Extracts material fragments from rectilinear-grid data (single grids or multiblock collections, typically CTH results) using cell-centred volume-fraction arrays and an isovalue. Fragments are built at sub-cell resolution with an extended marching-cubes table, connected across blocks and MPI processes, and returned as a multiblock dataset with one polydata block per material; cell data carry FragmentId and the integrated attributes such as MaterialVolume. Choose it for fragment counting and volume integration on rectilinear CTH data; for AMR input use pvMaterialInterfaceFilter or pvAMRFragmentsFilter.
  • pvRectilinearGridGeometryFilter — Converts a rectilinear grid (vtkRectilinearGrid: axis-aligned cells with separate coordinate arrays along x, y and z) into polygonal data. VTK can restrict this to an i-j-k extent, but ParaView exposes no extent, so the whole grid is used: a 3-D grid becomes a cloud of vertices (one per grid point), a 2-D grid a surface of quadrilaterals and a 1-D grid a polyline, with point and cell data carried over. Use surface or pvExtractSurface to get the outer surface of a 3-D grid instead.
  • pvRedistributeDataSet — Load-balances a dataset across MPI processes: it computes spatial cuts for the requested number of partitions and moves cells accordingly, assigning boundary cells to one region (ParaView default), duplicating them (marked as duplicate ghost cells) or splitting them. Output is an unstructured grid per process, or a vtkPartitionedDataSet with PreservePartitionsInOutput, and global cell ids can be generated. With default settings a serial run has one partition, so the main effect is conversion to an unstructured grid. It is the newer alternative to pvD3.
  • pvReductionFilter — Generic parallel reduction (vtkReductionFilter): an optional pre-gather algorithm runs on each MPI process, the results are gathered, and a post-gather algorithm combines them on one or all processes. The helpers are named by VTK class name (PreGatherHelperName, PostGatherHelperName); the helper proxies themselves cannot be set in Schemaxis. In a serial run there is a single piece, so the operation mainly applies the helpers to it. Prefer pvAppendReduce for the common gather-and-append case.
  • pvReflect — Mirrors the input across an axis-aligned plane and outputs an unstructured grid containing, by ParaView default, both the original and the mirrored copy (CopyInput). The plane is either a face of the input bounding box (X Min to Z Max) or x, y or z = Center. Vectors, normals and tensors are flipped; with FlipAllInputArrays (default true) every signed 3-, 6- or 9-component array is treated as a vector or tensor too. Use it to complete a symmetric half-model; the curated reflect uses the same filter with Schemaxis defaults (plane X at 0).
  • pvRemoteSourceProxy — ParaView's Remote Source Proxy (vtkPVMultiServerDataSource) mirrors, inside the client's built-in session, a dataset that lives on another server in a multi-server ParaView setup. It has no inputs or file and receives its data only through a native DependencyLink to that external proxy, which Schemaxis does not expose (it is listed as a property gap). In a Schemaxis workflow it therefore has nothing to fetch and is not a useful data source; use a reader or a source operation instead.
  • pvRemoveGhostInformation — Removes ghost cells and the vtkGhostType point and cell arrays from polydata or unstructured grids; for hyper tree grids it removes the ghost array and masks the ghost cells. Use it before writing or measuring data from a parallel pipeline so duplicated boundary layers are not exported or counted twice.
  • pvRenameArrays — Passes its input through unchanged except for array names. Each list property holds [current name, new name] pairs for one attribute type: points, cells, field data, graph vertices, graph edges or table rows. It accepts any data object, including composites and tables. Use it to give arrays the names a later step expects, e.g. to make datasets agree before pvAppendDatasets, or to replace solver names before export.
  • pvResampleAMR — Samples overlapping AMR data (vtkOverlappingAMR) onto a uniform grid covering the box from Min to Max with NumberofSamples points per axis, taking each value from the finest level that covers the sample. The result is a multiblock of uniform-grid partitions (NumberOfPartitions) with the fields on points (TransferToNodes true) or cells. Use it to compare AMR results with regular-grid data or to export a fixed-resolution image; use pvConvertAMRdatasettoMultiblock to keep the native blocks.
  • pvResampleToImage — Samples the input's point and cell arrays onto a new uniform image (vtkImageData) with SamplingDimensions points along x, y and z, spanning the input bounds (UseInputBounds, ParaView default) or custom SamplingBounds. Values are interpolated at the image points by a probe filter, so cell arrays also become point arrays, and points outside the input get 0 in the vtkValidPointMask array. Use it to convert unstructured results to a regular grid for image writers, volume rendering or pvHistogram2D; resample probes onto an existing mesh instead.
  • pvResampleToLine — Same native filter as pvPlotOverLine (vtkPVProbeLineFilter) with a different starting configuration: uniform sampling with Resolution 40 and the SamplingPattern hidden in ParaView's GUI. It returns a polyline with the input arrays interpolated along Point1-Point2 plus arc_length and vtkValidPointMask. Use it for a light uniform resampling, e.g. a coarse profile to compare between runs; use pvPlotOverLine or probeLine for detailed profiles.
  • pvResampleWithDataset — Samples the arrays of SourceDataArrays at the points of DestinationMesh: the output has the destination's geometry and structure, and its point data holds the source's point and cell values interpolated at each destination point plus a vtkValidPointMask array marking points found inside the source. Both inputs may be composite. Use it to transfer a solution onto another mesh, e.g. CFD results onto a structural or measurement mesh; resample is the curated version and pvResampleToImage samples onto a generated image.
  • pvResourceImageTexture — Typed texture resource (vtkTexture) that loads its image from a file such as a PNG or JPEG. It produces no dataset: other nodes reference it through texture inputs, currently pvLogo's Texture port, and several consumers may share it. Use it when the picture is a file on disk; use pvResourceTexture when the image comes from a pipeline node.
  • pvResourcePVLookupTable — Typed colour lookup-table resource (vtkPVDiscretizableColorTransferFunction) that maps data values to colours, either as a continuous colour map defined by RGBPoints control points or as categorical colours for annotated values (InterpretValuesAsCategories). It is not a dataset: it is connected to lookup-table inputs such as pvColorByArray, pvOMETIFFChannelCalculator or the PLY and OpenVDB writers, and several consumers can share one table. Scene appearances build their own colour maps from field, range and preset, so use this resource only for those explicit ports.
  • pvResourcePiecewiseFunction — Typed piecewise-function resource (vtkPiecewiseFunction) that maps a data value to a single number, normally opacity from 0 to 1, through control points. Its main use is the ScalarOpacityFunction input of pvResourcePVLookupTable, where it defines how transparent each data value is. It produces no dataset and can be shared by several lookup tables.
  • pvResourceTexture — Typed texture resource (vtkTexture) whose image comes from a connected pipeline node producing image data (vtkImageData), for example a PNG series reader or a resampled field. Like pvResourceImageTexture it is referenced by texture inputs such as pvLogo's Texture port and produces no dataset of its own. Choose it when the texture must follow pipeline changes; use pvResourceImageTexture to load a file directly.
  • pvResourceTransferFunction2D — Typed two-dimensional transfer-function resource (vtkPVTransferFunction2D): colour and opacity defined over two axes, usually a scalar on x and a second quantity such as gradient magnitude on y, as used by ParaView's 2-D volume rendering. It is built from coloured rectangles (Boxes) within Range and sampled to an image of OutputDimensions. In Schemaxis it only connects to the TransferFunction2D input of pvResourcePVLookupTable; Schemaxis scene appearances do not perform volume rendering.
  • pvRestartedSimExodusReader — Reads an Exodus simulation that was restarted, through a metadata file listing the output file sets of each restart, so they behave as one continuous time series. The output and the block, set, map and variable selections are those of pvExodusIIReader: a multiblock of unstructured grids with nodal and element variables, displacements applied by default. Use pvExodusIIReader for a single run's files.
  • pvRestartedSimSpyPlotReader — Reads a CTH (Spy Plot) simulation that was restarted, through a metadata file (.spcth-timeseries) listing the output file sets of each restart, so the sets behave as one continuous time series. Output port 0 is the volume data (hierarchical blocks with cell-centred arrays such as material volume fractions), port 1 the tracers and port 2 the markers; select a port with {"node": id, "port": n}. Use pvSpyPlotReader for a single .spcth case and pvspcthhistoryreader for history files.
  • pvReverseSense — Flips the orientation of polygonal data: ReverseCells (ParaView default true) reverses each cell's point order, which flips its implied front face, and ReverseNormals (default false) multiplies existing point and cell normals by −1. Use it when a surface's normals point inward, e.g. an STL with clockwise winding, before shading, normal-based glyphs or operations that assume outward orientation; normals with consistency orients a surface automatically.
  • pvRibbon — Turns lines and polylines (polydata, e.g. streamlines) into flat ribbon strips that follow each line. The ribbon's orientation comes from a normal: the 3-component point array chosen in Vectors, or the fixed DefaultNormal when UseDefaultNormal is true; with neither, VTK computes sliding normals for each line. Width is the half-width; VaryWidth scales it along the line by the Scalars array from Width at the array minimum to twice Width at its maximum, and Angle rotates the ribbon about the line. Use tube or pvTube for round tubes.
  • pvRotationalExtrusion — Sweeps polygonal data around an axis through the coordinate origin (RotationAxis, ParaView default z) to build a swept surface: free edges and lines become surfaces and vertices become lines, so a profile curve becomes an axisymmetric shell (cylinder, bottle), and Translation or DeltaRadius turn it into a spring or spiral. Capping closes the ends with copies of a filled 2-D input. Output is polydata, a surface rather than a volume; use pvVolumeOfRevolution to sweep 2-D cells into volume cells.
  • pvRuler — ParaView's ruler: a straight line (vtkLineSource) from Point1 to Point2 that ParaView's ruler representation labels with its length. In Schemaxis the output is only the line geometry; the distance is not stored in the data, so compute it from the two points when you need the value. Use it as a distance annotation; pvLine gives a subdivided line for probing.
  • pvSAVGReader — Reads a NIST SAVG file (.savg), a plain-text format of coloured points, lines and polygons used for immersive-visualization scenes. The output is a partitioned dataset collection with one polydata partition per primitive kind found (points, lines, polygons), with optional "rgba_colors" and "vertex_normals" point arrays. Use it to bring such scene geometry into a pipeline; it carries no simulation fields.
  • pvSEPReader — Reads Stanford Exploration Project seismic data: a text .H header describing up to 32 named axes (labels such as CDP, LINE, OFFSET, DEPTH) with their sizes, origins and sampling, which points to the raw .H@ data file. You choose which named axes become the output x, y and z (or x and y for 2-D output) and hold the remaining axes at one index each; the result is uniform image data with an ImageScalars array.
  • pvSLACDataReader — Reads the NetCDF-based mesh and mode files of SLAC's accelerator electromagnetics codes (Omega3P, Tau3P and related tools). MeshFileName is the element mesh; ModeFileName is one mode file (usually an eigenmode with electric and magnetic fields) or several files forming a time series. Output port 0 (External Surface) is the boundary surface and port 1 (Entire Volume) the volume mesh, filled only when ReadInternalVolume is enabled. When a mode file stores a frequency (100 or more, treated as hertz) the complex fields are animated over one period of the lowest frequency: each mode contributes magnitude × FrequencyScale × cos(initial phase + 2πft + PhaseShift) and the modes are summed.
  • pvSLACParticleDataReader — Reads particle data written by SLAC's accelerator codes (NetCDF files with the SLAC particle conventions) into polydata: a set of particle points in 3-D space. Several files form a time series, one file per step in the order listed. Use it with pvSLACDataReader to show particles inside the cavity fields.
  • pvSPHDatasetInterpolator — Interpolates particle data with smoothed-particle-hydrodynamics kernels: the Input is the particle set (a point set with point arrays, normally including density and optionally mass) and the Source is any dataset whose points receive the SPH-weighted values. The output keeps Source's structure and adds the interpolated arrays, a Shepard-sum array (on by default) and any derivative arrays. Use it to post-process SPH simulation output on meshes, slices or images; for non-SPH scattered data use pvPointDatasetInterpolator.
  • pvSPHLineInterpolator — Interpolates SPH particle data (Input) with SPH kernels onto a high-resolution straight line set in the Source options (Point1, Point2, Resolution; ParaView default 1000 intervals), producing a polyline profile with the interpolated arrays and a Shepard-sum array, e.g. a density or pressure profile through a particle simulation.
  • pvSPHPlaneInterpolator — Interpolates SPH particle data (Input) with SPH kernels onto a bounded plane set in the Source options (Center, Normal, BoundingBox, Padding, Resolution or CellSize), producing a planar grid of SPH-weighted values for heat-map sections through a particle simulation.
  • pvSPHVolumeInterpolator — Interpolates SPH particle data (Input) with SPH kernels onto a bounded volume set in the Source options (Origin, Scale, Padding, Resolution or CellSize), producing image data that can be contoured, sliced or volume-rendered as a continuous field.
  • pvSTEPReader — Reads a STEP CAD file through OpenCASCADE and tessellates its B-rep faces into triangles, giving a multiblock dataset with one polydata block per shape (named from the file, or Unnamed) and a per-cell Colors array from the CAD colours. LinearDeflection and AngularDeflection set how closely the triangles follow curved surfaces; ReadWire adds edges as polylines. Use it to bring CAD geometry in for rendering, clipping or probing; use pvIGESReader for .iges, and readSTL or pvSTLReader for already-tessellated STL.
  • pvSTLReader — Full native STL reader: reads ASCII or binary stereolithography files (.stl) into triangle polydata, and a list of several files into a time series. In ParaView 5.13.3 this proxy exposes only the file list (the ScalarTags option of the core reader is not exposed). For a single CAD surface the curated readSTL does the same with one file.
  • pvScatterPlot — ParaView's Scatter Plot: passes a dataset through unchanged (vtkPassThrough) and marks it for the plot-matrix view, which shows every pair of arrays as a scatter plot in the ParaView GUI. In Schemaxis the data result is the unchanged input.
  • pvSegYReader — Reads a SEG-Y seismic file. 3-D surveys become a structured grid (default) or, with StructuredGrid false, a lighter image data whose positions and shape may be approximate; 2-D lines become a structured grid sheet. Axes are crossline, inline and depth, and the trace samples are the point values. Trace positions come from source, CDP or custom header bytes, and VerticalCRS decides whether the vertical axis is height (positive up) or depth.
  • pvSelectionQuerySource — Creates a query selection, ParaView's "Find Data" mechanism: QueryString is a structured query over the input's arrays, element indices or locations, evaluated per element when pvExtractSelection (or another extractor) runs; the elements where it is true are selected. ElementType chooses cells (ParaView default) or points, and Selectors can restrict the query to some blocks of a composite input. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. For a plain range on one array, pvThresholdSelectionSource is simpler.
  • pvShrink — Moves the points of every cell toward that cell's centroid (average of its points) by ShrinkFactor, separating cells so individual elements become visible; output is an unstructured grid with unshared points. It is a mesh-inspection aid, not a geometric operation for measurements; the curated shrink offers the same with a Schemaxis default.
  • pvSlice — ParaView's general Slice filter: cuts any dataset (or hyper tree grid) with an implicit surface (Plane, Box, Sphere or Cylinder) and returns polygonal data, i.e. surfaces from volumes and lines from surfaces, with point data interpolated. SliceOffsetValues produces several parallel copies of the cut surface in one node, and Crinkle slice instead keeps the whole input cells crossed by the surface. Use slice for a simple plane with Schemaxis defaults, pvSliceWithPlane for a faster multithreaded plane cut, or pvAxisAlignedSlice for hyper tree grids.
  • pvSliceAlongPolyLine — Cuts a dataset with the curtain surface swept by moving a polyline parallel to the z-axis, like a vertical cross-section along a ship track, river or flight path. Connect the dataset to Dataset and the path (polydata containing a polyline) to PolyLine; the result is polygonal data with interpolated attributes. Only the polyline's x-y path matters. For a single straight cut use pvSlice or slice.
  • pvSliceWithPlane — Fast, multithreaded plane cut (vtkPVPlaneCutter) of any dataset, composite dataset, overlapping AMR or hyper tree grid, producing polygonal data with interpolated point data and transferred cell data. It accepts only planes (Plane or Axis Aligned Plane) and, for unstructured input, can build a sphere tree to accelerate repeated cuts. Choose it over pvSlice when a plane is all you need and speed matters, or when slicing AMR data at a chosen level; use pvSlice for spheres, boxes, cylinders or offset copies.
  • pvSmooth — Laplacian smoothing of a polygonal surface: each point moves iteratively toward the average of its connected neighbours, for up to NumberofIterations (ParaView default 20) or until the largest motion falls below Convergence. VTK's relaxation factor of 0.01 keeps each step small. Connectivity, point count and arrays are unchanged. Use it to reduce noise or faceting of scanned or iso-surfaces; smooth is the curated version.
  • pvSpatioTemporalHarmonics — Adds a point array SpatioTemporalHarmonics (set as active scalars) whose value at point x and time t is the sum over harmonics of A·sin(k·x + ω·t + φ), with t the requested pipeline time and x in dataset coordinates. It produces analytic, time-varying test fields, e.g. to check interpolation, temporal statistics or FFT workflows against known waves.
  • pvSpatioTemporalHarmonicsUniformGrid — Generates image data (a uniform grid with spacing 1 over WholeExtent) with a time-dependent point array "SpatioTemporalHarmonics" = Σ A·sin(ω·t + k·x + φ), summed over the listed harmonics, at each listed time step. The ParaView defaults give four harmonics and 20 time steps over one 2π period, so the animation loops. Use it to test temporal filters, animation and time-dependent exports with a known analytic field; use pvWavelet for a static analytic volume.
  • pvSphere — Creates a polygonal sphere (or a section of one) with point normals: radius Radius around Center, tessellated by ThetaResolution longitude and PhiResolution latitude divisions. StartTheta/EndTheta (around z, 0 to 360 degrees) and StartPhi/EndPhi (from +z at 0 to -z at 180 degrees) cut out partial spheres. Use it as reference geometry or a probe surface; the curated sphere operation offers Schemaxis defaults.
  • pvSplineSource — Creates a smooth curve through control points: a parametric spline (ParametricFunction "Spline", with its own Points and Closed options) tessellated into a polyline of Resolution points. Use it for smooth seed or probe paths and annotation curves; pvPolyLineSource joins the points with straight segments instead.
  • pvSpyPlotReader — Reads a CTH Spy Plot case: an ASCII .spcth case file listing the binary files that hold the data. Output port 0 is the volume data (a hierarchical composite of blocks with cell-centred arrays), port 1 the tracers and port 2 the markers. By ParaView default it derives material densities from selected material mass and volume fraction and merges X/Y/Z component arrays into vectors. Use pvRestartedSimSpyPlotReader for a restarted run split over several file sets and pvspcthhistoryreader for history files.
  • pvStitchImageDataWithGhosts — Joins image blocks that are separated by a one-voxel gap, such as blocks written independently by each process, by generating ghost points at the new interfaces, so the partitions behave as one continuous image. Input is image data or a composite of images with point data only. Use it before contouring or gradients on such tiled images to avoid gaps.
  • pvStreakLine — Computes streaklines in an unsteady (time-dependent) vector field: particles are released from every SeedSource point at each input time step and advected through the changing field, and the particles released from the same place are joined into lines, the analogue of continuous dye injection. ParaView requests the input time steps itself, from the first step up to the requested time, so the input must have at least two time steps and a 3-component point vector field. Output is polydata (polylines, single points as vertices) with ParticleAge, ParticleId, InjectedPointId and the interpolated input arrays. Use pvStreamTracer for a steady snapshot and pvTemporalParticlesToPathlines to draw trails of existing particles.
  • pvStreamTracer — Integrates steady streamlines through one time step of a 3-component vector field, forward, backward or both, from seeds made by the built-in SeedType generator (Point Cloud, the ParaView default, or Line). The output is polydata polylines carrying the input point arrays interpolated along each line, IntegrationTime, and cell arrays SeedIds and ReasonForTermination (1 left the domain, 4 maximum length, 5 maximum steps, 6 below terminal speed); with ComputeVorticity on (ParaView default) Vorticity, Rotation, AngularVelocity and Normals are added. Use the curated streamTracer for the common case, pvStreamTracerWithCustomSource to seed from another node's points, and pvStreakLine or pvTemporalParticlesToPathlines for unsteady flow.
  • pvStreamTracerWithCustomSource — Integrates steady streamlines like pvStreamTracer, but every point of a second input (SeedSource) that lies inside the dataset starts a streamline, so any node's points can seed it: a probe line, a slice, an inlet patch or points read from a file. The vector field must be point-centred with 3 components. The output is polydata polylines carrying the input point arrays interpolated along each line, IntegrationTime, and cell arrays SeedIds and ReasonForTermination (1 left the domain, 4 maximum length, 5 maximum steps, 6 below terminal speed); with ComputeVorticity on (ParaView default) Vorticity, Rotation, AngularVelocity and Normals are added. With direction BOTH, N seeds give up to 2N lines.
  • pvSubdivide — Refines a triangle mesh linearly: each pass splits every triangle into four by adding a point at the midpoint of each edge, so the original surface shape and points are kept exactly while the resolution increases. Use it to give a coarse triangulated surface more points before interpolating onto it, warping or sampling. Input must be polydata of triangles (run triangulate first); use pvLoopSubdivision for a smoothed surface.
  • pvSuperquadric — Creates a superquadric surface with normals and texture coordinates: one family covering ellipsoids, rounded boxes, cylinders and tori, chosen by the ThetaRoundness and PhiRoundness exponents (1 = round, near 0 = square-edged, above 1 = pinched). With Toroidal true (the ParaView default) it is a torus-like ring whose hole size is set by Thickness. Use it for test geometry or glyph shapes.
  • pvSurfaceFlow — Computes the net flux of a point vector field through a surface: at each point it takes the dot product of the vector with a normal averaged from the neighbouring 2-D cells, then integrates it over the surface with Integrate Variables. The output is a one-point unstructured grid whose point array Surface Flow holds the integral (vector units times area), e.g. a volumetric flow rate when the vector is velocity. Use it on a slice, a boundary patch or any 2-D surface; integrate gives other surface integrals.
  • pvSurfaceNormals — Computes point normals (array Normals) on polygonal surfaces by averaging the normals of the polygons around each point, for smooth shading and for operations that need surface normals. By ParaView default polygon ordering is made consistent and points are split along edges sharper than FeatureAngle (30 degrees), keeping edges crisp but duplicating points; cell normals can be output too. The curated normals operation uses the same algorithm with Schemaxis defaults (splitting off).
  • pvSurfaceTangents — Computes per-point tangent vectors (array Tangents) of a triangulated surface from its point normals and texture coordinates, as required for normal-map texturing in rendering. The input must be triangle polydata with point Normals and texture coordinates; the output is the same polydata with tangents added. Use it only for textured rendering; it has no analysis meaning.
  • pvSurfaceVectors — Constrains a point vector field on a 2-D surface relative to the local surface normal (averaged from neighbouring 2-D cells). Parallel removes the normal component, leaving the tangential part (e.g. wall shear direction or surface streamlines); Perpendicular keeps only the normal component; PerpendicularScale outputs the signed normal component as a new scalar array named Perpendicular Scale. The modified vectors keep the input array name; geometry is unchanged. pvSurfaceFlow uses the PerpendicularScale mode internally to compute fluxes.
  • pvSynchronizeTime — Snaps the time values of one dataset to those of another. DataToPass supplies the data and its time steps; any of its time values within RelativeTolerance × (its time range) of a TimeToSync time value is replaced by that value, so both sources report identical times, e.g. a simulation written at 0.1000001 s and experimental data at 0.1 s. The output keeps DataToPass's data and number of time steps; only the time labels change.
  • pvTIFFReader — Reads one TIFF file (.tif, .tiff) into uniform image data; it is kept for backward compatibility, and pvTIFFSeriesReader reads the same files with stacking, time series and custom spacing added. Spacing comes from the TIFF resolution tags when present (converted to millimetres for inch or centimetre units), otherwise 1.
  • pvTIFFSeriesReader — Reads TIFF images (.tif, .tiff; 8- or 16-bit integer or 32-bit float) into uniform image data. Several files are stacked as z slices by default (ReadAsImageStack true) or read as a time series. Spacing comes from the TIFF resolution tags (millimetres for inch or centimetre units, otherwise 1) unless UseCustomDataSpacing applies CustomDataSpacing. Pair with pvWriteTIFFWriter for round trips; use pvOMETIFFReader for OME-TIFF.
  • pvTRUCHASReader — Reads output of TRUCHAS (Los Alamos casting, solidification and heat-transfer code) stored in HDF5 into a multiblock dataset, with selectable mesh blocks and point and cell arrays at each stored time step. Use it to inspect temperature, phase fraction or flow fields of casting simulations.
  • pvTableFFT — Computes the discrete Fourier transform of every numeric column of a table (columns whose names start with vtk are skipped; 2-component columns are treated as complex), returning a table of spectra. The sampling rate is taken from a column named Time (any capitalization, assumed evenly spaced) or else from DefaultSampleRate (ParaView default 10000 Hz), and a Frequency column is added by default. Use it for spectra of probe histories, e.g. pressure fluctuations over time from a plot-over-time table; enable UseWelchMethod for an averaged, smoother spectrum of long noisy signals.
  • pvTableToPoints — Turns a table (e.g. a CSV file of x, y, z samples) into polydata points: three numeric columns give the coordinates and the other columns become point arrays. The coordinate columns are removed from the arrays unless KeepAllDataArrays is on; with a2DPoints the Z column is ignored and z = 0. Use it to place measurement or particle data in space for probing, interpolation or glyphs.
  • pvTableToStructuredGrid — Turns a table into a curvilinear structured grid: X, Y and Z columns give the point coordinates, row order is point order with i varying fastest, then j, then k, and the other columns become point arrays. WholeExtent gives the grid's index ranges, and the table must have exactly (imax-imin+1)(jmax-jmin+1)(kmax-kmin+1) rows. Use it for gridded data exported row by row, e.g. a CSV of a structured solver block; use pvTableToPoints for scattered points.
  • pvTecplotReader — Reads ASCII Tecplot files (.dat, .tec, .tp) into a multiblock dataset with one block per zone; each block is a structured grid (ordered zones) or unstructured grid (finite-element zones). Point-packed zones give point data only; block-packed zones may carry point or cell data. Several files form a time series. Use pvTecplotTableReader for Tecplot data that is a plain table, and pvVisItTecplotBinaryReader for binary .plt files.
  • pvTecplotTableReader — Reads a Tecplot ASCII data file (.dat) as a table (vtkTable): one column per variable and one row per data record, with column names taken from a header line. It creates no geometry, so it suits point-wise or line data for plots and table exports. Use pvTecplotReader for Tecplot zone (mesh) data and pvCSVReader for comma-separated tables.
  • pvTemporalArrayOperator — Combines one array at two of the input's stored time steps, chosen by zero-based indices (FirstTimeStepIndex, SecondTimeStepIndex), with +, -, * or / applied value by value as first-operator-second. The output is the dataset at the second step plus one new array named after the input array with a suffix (by default _add, _sub, _mul or _div), e.g. p_sub for the pressure change between two saved times. Both steps must hold the array with the same number of tuples and components, so the mesh must not change. Use temporalStatistics or pvTemporalStatistics for averages over all steps.
  • pvTemporalCache — Keeps copies of the input at up to CacheSize recently requested time steps (ParaView default 2, range 2 to 10) and returns a cached copy when the same time is requested again, instead of re-running the upstream pipeline. Data and time values are unchanged. It helps when downstream temporal filters, e.g. pvTemporalInterpolator, repeatedly request the same steps from an expensive reader or filter chain.
  • pvTemporalCacheSource — The same cache as pvTemporalCache (vtkTemporalDataSetCache), registered by ParaView as a source with IsASource true, the configuration meant for Catalyst in-situ pipelines: it then reports only the times currently held in the cache as its time steps and keeps entries even when the upstream pipeline changes, so it can hold a short history of a live simulation. For post-processing stored results use pvTemporalCache.
  • pvTemporalInterpolator — Linearly interpolates point coordinates and point and cell arrays between the two stored time steps around a requested time, so data can be obtained at times the input did not save; ParaView uses vtkAdaptiveTemporalInterpolator, which also copes when the mesh appears to change between steps. By ParaView default it reports the input's own steps; DiscreteTimeStepInterval reports evenly spaced steps instead and ResampleFactor adds steps inside each stored interval. The input needs at least two time steps, and interpolated values are a linear approximation, not solver results.
  • pvTemporalParticlesToPathlines — Builds trails from moving particles: it takes a point set whose points move between time steps (e.g. Lagrangian particles read from a solver, or a particle tracer's output) and joins each particle's successive positions into a polyline. ParaView loops over the input times itself up to the requested time. Output port 0 (Pathlines) holds the trails with TrailId and TrackLength; port 1 (Particles) holds one vertex at each trail's head. Particles are matched by IdChannelArray (global ids or point index by default). Use pvStreakLine to compute particle motion from a velocity field instead.
  • pvTemporalShiftScale — Relabels time without touching the data: an input time t is reported as (t + PreShift) × Scale + PostShift, and a request for output time T fetches input time (T − PostShift) / Scale − PreShift. Use it to align runs that started at different times, change time units (Scale 0.001 turns milliseconds into seconds), or repeat a cyclic dataset with Periodic. Nothing is resampled; use pvTemporalInterpolator for in-between states.
  • pvTemporalSmoothing — Replaces each point and cell array value by its plain (unweighted) mean over a sliding window of 2 × TemporalWindowHalfWidth + 1 stored time steps centred on the requested step. The output is still temporal, but loses HalfWidth steps at each end of the series, and requests outside the remaining range use the nearest available step. Use it to suppress step-to-step noise in transient results; the number and order of points and cells must not change over time.
  • pvTemporalSnaptoTimeStep — Makes a request for any time return the data of one of the input's stored time steps: SnapMode picks the nearest stored step (ParaView default), the last step at or below, or the first step at or above the requested time. Data are neither modified nor interpolated. Use it when scene times do not match the saved solver times exactly; use pvTemporalInterpolator to blend between steps instead.
  • pvTemporalStatistics — Computes, for every point and cell array of a time-dependent input, its average, minimum, maximum and population standard deviation over all input time steps, which the filter requests itself. The output has the input's type and geometry, no time, and arrays named <name>_average, <name>_minimum, <name>_maximum and <name>_stddev (other arrays are not kept). Every step is weighted equally regardless of time spacing, so this is not a time integral. This is the generated binding with native names (ComputeAverage, …); the curated temporalStatistics does the same with shorter option names.
  • pvTensorGlyph — Places a glyph (sphere by ParaView default; cylinder, box or superquadric) at every point and scales and orients it by the eigen-decomposition of the symmetric part of a point tensor: the major eigenvalue scales the glyph's x axis along the major eigenvector, the medium y, the minor z. Tensors may have 9 components or 6 symmetric components ordered XX, YY, ZZ, XY, YZ, XZ. Output is polydata, by default coloured by input scalars. Use it for stress, strain or diffusion tensors; pvGlyph handles vectors.
  • pvTensorPrincipalInvariants — Computes the principal values and principal directions of selected symmetric tensor arrays (for example stress or strain). For each selected array <name> it adds <name> - Sigma 1, 2 and 3 (values sorted from largest to smallest) and the matching <name> - Sigma n (Vector) direction arrays, keeping the input arrays. Accepted tensors have 6 components in the order XX, YY, ZZ, XY, YZ, XZ, or 3 components named XX, YY, XY for 2-D tensors. Use pvYieldCriteria when you need Tresca or von Mises values.
  • pvTessellate — Subdivides cells with non-linear geometry or fields (quadratic and higher-order cells) into linear simplices (tetrahedra, triangles or lines up to OutputDimension) until the chord error and optional per-field errors at edge midpoints fall below their limits, giving an unstructured grid that approximates curved geometry and fields with linear pieces. Use it before operations or exports that only handle linear cells; linear input is just split into simplices.
  • pvTest3DWidget — ParaView-internal test proxy: a vtkConeSource exposing only Resolution, with VTK's cone defaults (height 1, radius 0.5, apex along +x, centred at the origin). It exists to test 3-D widgets and has no analysis purpose; use pvCone or the curated cone operation for real cone geometry.
  • pvTetrahedralize — Splits all 3-D cells into tetrahedra and 2-D cells into triangles, producing an unstructured grid; point data are unchanged and cell data are copied to the pieces. Use it when a later step or export needs simplices only. ParaView warns on creation because the cell count can grow several-fold.
  • pvText — Source that produces a one-row, one-column table whose Text column holds the whole Text string as a single cell; the string is not split. ParaView's help describes '|' as a column separator and newlines as rows, but that applies to ParaView's text display of the table, not to the table vtkPVTextSource outputs. Use it for titles, captions or a fixed label; use pvAnnotateTime or pvAnnotateAttributeData for text derived from time or data.
  • pvTextureMaptoCylinder — Adds 2-D texture coordinates (point array "Texture Coordinates") by projecting each point onto a cylinder: s follows the angle around the axis and t the position along it, 0 at Point1 and 1 at Point2. The axis is fitted automatically from an oriented bounding box (ParaView default) or given by Point1 and Point2. Use it to wrap an image texture around roughly cylindrical geometry such as pipes or vessels; pvTextureMaptoPlane suits flat parts. The geometry and other arrays pass through unchanged.
  • pvTextureMaptoPlane — Adds 2-D texture coordinates (point array "Texture Coordinates") by projecting each point onto a plane. In automatic mode (ParaView default, used while Origin and Point1 are both [0, 0, 0]) a least-squares plane is fitted and s and t run from 0 to 1 across the projected bounds. Otherwise s is the projection of (point − Origin) on Point1 − Origin, divided by that edge's squared length, and t likewise with Point2, so s and t are 0 at Origin and 1 at Point1 or Point2. Use it to drape an image (e.g. a photograph or map) on a flat or gently curved surface; pvTextureMaptoCylinder suits round parts.
  • pvTextureMaptoSphere — Adds 2-D texture coordinates (array Texture Coordinates) by projecting each point onto a sphere centred at the mean of the input points: s runs around the z axis, counter-clockwise from +x, and t increases from the north pole towards the south pole, both within 0 to 1. Use it to wrap an image texture, e.g. a map, onto roughly spherical geometry in rendered scenes; geometry and data values are unchanged.
  • pvThreshold — Extracts the cells whose values of a chosen point or cell array satisfy a criterion (Between LowerThreshold and UpperThreshold, below the lower or above the upper), producing an unstructured grid (or a masked hyper tree grid). It exposes the full native control: component handling for vector arrays (one component, magnitude, All or Any), Invert, AllScalars for point data and a continuous cell range. Use threshold for the common inclusive range test with validated field names; use pvClip with a scalar clip for smooth cuts through cells.
  • pvThresholdSelectionSource — Creates a threshold selection: elements whose value of ArrayName lies inside any of the [min, max] ranges in Thresholds (inclusive), on cells or points per FieldType. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Unlike threshold or pvThreshold it does not change the data by itself, so the same selection can be reused, inverted with InsideOut or grown with NumberOfLayers.
  • pvThresholdTable — Keeps the rows of a table (vtkTable) whose value in one numeric column satisfies a threshold: below MaxValue, above MinValue, between them, or outside them. The output is a table with the same columns and the same or fewer rows. Use it to filter CSV data, statistics output or probe tables; use threshold or pvThreshold for meshes.
  • pvTimeSource — Test source with time: an unstructured grid of one unit voxel cell (or a column of voxels along y that grows and shrinks over time when Growing is on) carrying "Point Value" and "Cell Value" arrays equal to sin(2πt) plus label and coordinate arrays, over the time range 0 to 1 with ten discrete steps. XAmplitude and YAmplitude move the cell along a sine path over time. Use it to check time handling ($time, animation, temporal filters) without a real case.
  • pvTimeStepProgressBar — Produces a one-row, one-column table with a ProgressRate value between 0 and 1 giving the position of the input's current time within its time steps or time range. In ParaView it drives a progress-bar annotation in an animation; in Schemaxis the result is just that table. Any time-dependent input works; the input data are not passed through.
  • pvTransform — Applies a translation, rotation and scaling (Transform, ParaView default the Transform3 'Transform' choice, identity until set) to point coordinates. Point-set inputs keep their type; image and rectilinear inputs come out as structured grids. Vectors and normals are rotated with the geometry and, with TransformAllInputVectors (ParaView default true), every other 3-component array too. The curated transform is the simpler alternative.
  • pvTransposeTable — Builds a sub-table from selected columns of a table and, by default, transposes it so that each selected column becomes a row; a first column holding the original column names is added by default. With Onlyextractselectedcolumns it skips the transposition and simply returns the selected columns. Use it to reshape statistics or probe tables for plotting or export.
  • pvTriangleStrips — Joins triangles into triangle strips and line segments into polylines (vtkStripper), giving more compact polydata with the same geometry. Other polygons and existing strips or polylines pass through, and cell data is discarded because the cells change. Its main use in workflows is joining separate segments into polylines (JoinContiguousSegments), e.g. contour or slice lines before pvDecimatePolyline, pvPolylineLength or tube.
  • pvTriangulate — Converts polygonal data to triangles, lines and vertices only: polygons are triangulated, triangle strips split into triangles and polylines into single segments (vtkTriangleFilter). The output stays polydata with the same points. Use it before operations that need triangles, such as decimate, pvDecimate or pvSurfaceTangents, or before triangle-only exports; triangulate is the curated equivalent and pvTetrahedralize handles volume cells.
  • pvTrivialProducer — Wraps an already-existing VTK data object so it can feed a pipeline (vtkTrivialProducer). The data must be attached by native code (SetOutput); authored Schemaxis input cannot do that, so in a workflow this source has nothing to produce. Schemaxis uses the class internally in its writer qualification tool, not as an authoring operation. Use a reader or a source operation for real data.
  • pvTube — Wraps every line or polyline of polygonal input in a tube of NumberofSides faces (ParaView default 6) and Radius, producing polydata surfaces. VaryRadius can make the radius follow a point scalar or vector array, up to RadiusFactor times Radius. The cross-section is oriented by the input's point Normals array, by normals generated along each line, or by DefaultNormal when UseDefaultNormal is true. Use it to render streamlines, particle paths or wire models in 3-D; tube is the curated version.
  • pvUnstructuredCellTypes — Generates an unstructured grid made of one chosen cell type (linear, quadratic, Lagrange or Bezier lines, triangles, quads, tetrahedra, hexahedra, wedges, pyramids, polyhedra…) by filling a BlocksDimensions grid of unit blocks starting at the origin; one block may hold several cells (e.g. six pyramids). Point arrays "DistanceToCenter" and "Polynomial" give known fields. Use it to test how filters, writers or renderers handle a specific cell type or element order.
  • pvUnstructuredNetCDFPOPreader — Reads Parallel Ocean Program (POP) NetCDF output (.pop.nc, .pop.ncdf) and converts its logically structured grid into an unstructured grid on a sphere: horizontal positions come from a companion GRID.nc file in the same folder, and each layer's depth_t is subtracted from an Earth radius of 6371000 (metres), so deeper layers lie closer to the sphere's centre. Stride subsamples and VOI crops the structured index space before conversion. Use pvNetCDFPOPreader for the structured form.
  • pvVASPAnimationReader — Reads a VASP molecular-dynamics animation file (NPT_Z_ANIMATE.out) into a time-varying vtkMolecule, one frame of atom positions per time step. Use it to animate or analyse trajectories from VASP runs; pvVASPTessellationReader reads the matching Voronoi tessellation file. vtkMolecule output needs pvMoleculeToLines before ordinary dataset filters.
  • pvVASPTessellationReader — Reads a VASP NPT_Z_TESSELLATE.out file. Output port 0 is the molecule (vtkMolecule) and port 1 the Voronoi tessellation of the atoms as an unstructured grid, one cell per atom, for each time step. Select port 1 with {"node": id, "port": 1} to measure or render Voronoi cells. Use pvVASPAnimationReader for the trajectory alone.
  • pvVPICReader — Reads VPIC kinetic plasma particle-in-cell output through its ASCII .vpc file, which describes the per-processor data files, grid size and time steps. Field and hydro quantities are assembled into one uniform image (vtkImageData) of point arrays. Stride subsamples the grid, and XExtent, YExtent and ZExtent restrict which simulation files (the per-processor tiling of the domain) are read, so a subregion can be viewed at full resolution. This is a distributed reader.
  • pvVRMLReader — Reads the geometry of a VRML 2.0 scene (.wrl, .vrml) through VTK's VRML importer: shapes become polygonal data that, by default, are appended into one block of a multiblock output with a colour array; lights, cameras and textures are dropped. Use it to bring VRML exports from CAD or visualization tools into a pipeline as surfaces.
  • pvVTKHDFReader — Reads VTK's HDF5-based VTKHDF format (.vtkhdf, .hdf): image data, polydata, unstructured grids, overlapping AMR, hyper-tree grids, partitioned collections and multiblock data, including transient data stored in one file. MergeParts (ParaView default true) merges partitioned pieces into one dataset. Several files in FileName form a time series. Choose it for large VTK data written by vtkHDFWriter or simulation codes; use the XML readers (pvXMLUnstructuredGridReader and others) for .vtu/.vtp-style files.
  • pvValidateCells — Checks every cell for defects that break other filters and adds a cell array ValidityState: 0 for a valid cell, otherwise a bit field of problems such as wrong number of points, intersecting edges or faces, non-contiguous edges, non-convexity, or wrongly oriented faces. Geometry and arrays pass through. Use it to diagnose meshes that fail in clipping, integration or export, then threshold on ValidityState to locate bad cells.
  • pvValueSelectionSource — Creates a value selection: elements whose value of ArrayName equals one of the listed integer values, e.g. all cells with MaterialId 3 or 7. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. ParaView documents that it cannot select within composite datasets. Use pvThresholdSelectionSource for value ranges or floating-point data.
  • pvVelodyneAMRReader — Reads Velodyne AMR files (.xamr) into an overlapping AMR dataset: nested refinement levels of uniform blocks with cell-centred variables. Level sets the finest level loaded, counted from the root level 0 (ParaView default 15, which in practice loads all levels of most files), and every variable starts disabled, so name the ones you need in CellArrayStatus. Several files form a time series. pvVisItVelodyneReader is the VisIt-based alternative for Velodyne data.
  • pvVisItANSYSReader — Reads an ASCII ANSYS input deck (.inp) through VisIt's ANSYS plugin: the nodes and elements in its NBLOCK and EBLOCK blocks become one unstructured-grid block named "mesh". The plugin defines no variables or materials, so the result is geometry only. ParaView 5.13.3 has no native reader for ANSYS input decks in the Schemaxis catalogue. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItAUXFileReader — Reads an ASCII .aux fluence file through VisIt's AUXFile plugin: the output is a 2-D rectilinear grid named "mesh" carrying one point array, "fluence". The format is documented only by the plugin source; choose this reader only for files written in that layout. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItBOVReader — Reads VisIt's BOV (brick of values) format: a short text header (.bov) giving DATA_FILE, DATA_SIZE, DATA_FORMAT, BRICK_ORIGIN, BRICK_SIZE, VARIABLE and CENTERING for one raw binary array on a regular grid. The output is a rectilinear-grid block named "mesh" carrying that one variable. Use pvImageReader instead for raw volumes without a BOV header, where you supply dimensions, spacing and data type yourself. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItCEAucdReader — Reads the CEA (French Alternative Energies and Atomic Energy Commission) variant of AVS UCD (.ucd, .inp), where a case is split into per-domain UCD files plus a root file holding time, cycle and material names. The output is one unstructured mesh named "mesh" with one domain per file, point and cell arrays from the files and optional material volume fractions. For ordinary single-file AVS UCD data use the native pvAVSUCDReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItCMATReader — Reads ASCII output of the CMAT Fortran simulation code (.cmat): a 2-D rectilinear mesh named "Mesh" with one cell-centred variable "M". Neither ParaView nor VisIt documents the code further; choose this reader only for CMAT output. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItCTRLReader — Reads the control (ctrl) input file of the TB-LMTO (tight-binding linear muffin-tin orbital) electronic-structure code: the atom sites become a point mesh named "mesh" with a point array "element". VisIt's element-name labels and unit-cell metadata are not converted by the bridge, so the result is a point cloud of sites, not a molecule with bonds. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItChomboReader — Reads HDF5 plotfiles from the Chombo block-structured adaptive mesh refinement framework (LBNL). With only the AMR mesh selected the output is vtkOverlappingAMR (patches on refinement levels); with other meshes selected it is a multiblock dataset. ParaView 5.13.3 has no native Chombo reader; AMReX/BoxLib plotfiles should use pvAMReXBoxLibGridReader instead. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItClawReader — Reads Clawpack/AMRClaw ASCII output through a small .claw boot file whose DIR=, TIME_FILES_SCANF/REGEX and GRID_FILES_SCANF/REGEX (and optional CYCLE_REGEX) lines locate the time-header and grid-data files. The output is a multiblock dataset in which "claw_mesh" holds every grid of every refinement level, with cell-centred solution components. The captured ParaView summary ("a material-ordered format very similar to IOUT=1") does not describe what the plugin source reads. One file supplies every time step the format stores.
  • pvVisItCurve2DReader — Intended for VisIt's ASCII curve format (.curve, .ultra, .ult, .u): named x-y curves, one pair per line. The plugin describes these as VisIt curves, but the bridge converts only meshes listed in the plugin metadata (vtkAvtFileFormatAlgorithm), so the output is probably an empty multiblock; this has not been verified. For x-y columns prefer pvCSVReader, then pvTableToPoints or a table plot. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItDDCMDReader — Reads particle and atom snapshot files from ddcMD, LLNL's domain-decomposition molecular dynamics code. Particle files become a point mesh with per-particle fields (species, type, group and the recorded quantities); cgrid files become a rectilinear grid. ParaView 5.13.3 has no native ddcMD reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItDyna3DReader — Reads DYNA3D input decks (.dyn) for LLNL's explicit finite-element structural code: control, material, node and element cards become one unstructured mesh named "mesh" with material volume fractions and per-element material properties (density, strength, plastic strain, material number). It reads model input, not results; LS-DYNA d3plot result databases need pvLSDynaReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItExtrudedVolReader — Reads VisIt's ExtrudedVol format: a text header (.exvol) naming a file stem, a chunk count, a time count and variables, with connectivity and variable files per chunk. The output is an unstructured mesh named "wedge_mesh" with node-centred variables. VisIt itself can write this format; ParaView has no other reader for it. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItFLASHReader — Reads HDF5 checkpoint and plot files of the FLASH multiphysics AMR code. With only "amr_mesh" selected the output is vtkOverlappingAMR; adding particles or diagnostic meshes gives a multiblock dataset. The native pvFlashReader (hierarchical-box AMR) and pvFLASHAMRParticlesReader are the usual choice; use this reader to cross-check them or to get the AMR blocks and particles from one node. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItFluentReader — Reads a legacy ANSYS Fluent case file (.cas) together with the .dat data file of the same name: the mesh becomes one unstructured block named "Mesh" with cell-centred solution fields. The native pvFluentCaseReader (legacy .cas/.dat, distributed) and pvFluentCFFCaseReader (.cas.h5/.dat.h5) are normally preferable; this reader is a cross-check when the native reader rejects a file. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItGGCMReader — Reads output of the (Open)GGCM Geospace General Circulation Model of the magnetosphere (.3df and .mer files; the plugin derives the companion grid-file name from the data-file name). The output is a rectilinear grid named "GGCM mesh" with node-centred fields. ParaView 5.13.3 has no native GGCM reader. One file supplies every time step the format stores.
  • pvVisItGTCReader — Reads HDF5 particle output of GTC, the Gyrokinetic Toroidal Code for fusion-plasma turbulence: the particles become a point mesh named "particles" with node-centred particle properties. ParaView 5.13.3 has no native GTC reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItGULPReader — Reads trajectory files (.trg) from GULP, the General Utility Lattice Program for atomistic simulation: each frame becomes a time step of a point mesh of atoms named "mesh" with per-atom energy, velocity and force components. ParaView 5.13.3 has no native GULP reader. One file supplies every time step the format stores.
  • pvVisItGadgetReader — Reads snapshot files of Gadget-2, the cosmological N-body/SPH code: particle positions become a point mesh named "POS " and the other particle blocks become arrays. ParaView 5.13.3 has no native Gadget reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItH5NimrodReader — Reads HDF5 output of NIMROD, the extended-MHD code for fusion plasmas, in its H5Nimrod data model (.h5nimrod): a curvilinear mesh with node- and cell-centred fields over several time steps. ParaView 5.13.3 has no native NIMROD reader. One file supplies every time step the format stores.
  • pvVisItImageReader — Reads images through VisIt's Image plugin: PNM/PPM, Stimulate SDT/SPR and .imgvol image stacks. It offers two rectilinear meshes, "ImageMesh" with pixel values as cell data and "ImageMesh_nodal" with them as point data. For PNG, JPEG or TIFF series the native pvPNGSeriesReader, pvJPEGSeriesReader and pvTIFFSeriesReader give vtkImageData directly; pvImageReader handles headerless raw volumes. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItLAMMPSDumpReader — Reads LAMMPS molecular-dynamics dump files (.dump, text with ITEM: sections) in which one file holds many time steps: each step becomes a time of a point mesh of atoms with the dumped per-atom columns as point arrays. ParaView 5.13.3 has no native LAMMPS dump reader; pvVisItLAMMPSStructureReader reads LAMMPS structure files instead. One file supplies every time step the format stores.
  • pvVisItLAMMPSStructureReader — Reads LAMMPS atom structure files (registered for .eam, .meam, .rigid and .lammps): atom positions become a point mesh named "mesh" with per-atom id and species arrays. Use pvVisItLAMMPSDumpReader for dump trajectories. ParaView 5.13.3 has no native reader for these files. One file supplies every time step the format stores.
  • pvVisItLinesReader — Reads VisIt's ASCII Lines format (.lines): named polylines given as coordinate lists. The output is one unstructured mesh named "Lines" of line cells, with no variables. For point coordinates in CSV columns pvCSVReader with pvTableToPoints is the native route. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItM3DC1Reader — Reads HDF5 output of M3D-C1, the high-order finite-element extended-MHD code for tokamak plasmas: the element mesh and the equilibrium mesh become unstructured blocks with node- and cell-centred fields over several time slices. The plugin's VisIt read options stay at their defaults. ParaView 5.13.3 has no native M3D-C1 reader. One file supplies every time step the format stores.
  • pvVisItM3DReader — Reads output of M3D, the multilevel 3-D MHD code for fusion plasmas (.m3d, .h5): an unstructured mesh named "mesh" with node-centred fields over the stored time steps. ParaView 5.13.3 has no native M3D reader; for M3D-C1 output use pvVisItM3DC1Reader. One file supplies every time step the format stores.
  • pvVisItMFIXCDFReader — Reads the netCDF-based output of MFiX (NETL's Multiphase Flow with Interphase eXchanges code): the fluid grid "Mesh" with cell-centred gas and solids fields over time, plus a "flagclass" mesh of cell flags. The native pvMFIXReader reads the classic .RES/SP* format, not this netCDF variant. One file supplies every time step the format stores.
  • pvVisItMFIXReader — Reads classic MFiX output: the .RES restart file (mesh and run information) with its SP* result files. The output is the fluid grid "Mesh" with cell-centred fields over time. The native pvMFIXReader reads the same files into an unstructured grid and is normally preferable; use this reader as a cross-check or for the flag-class mesh. One file supplies every time step the format stores.
  • pvVisItMM5Reader — Reads output of the PSU/NCAR Mesoscale Model (MM5) for regional weather simulation: rectilinear grids with cell-centred meteorological fields over the stored times. ParaView 5.13.3 has no native MM5 reader; netCDF output from MM5's successor WRF can often use pvNetCDFReader instead. One file supplies every time step the format stores.
  • pvVisItMiliReader — Reads Mili, LLNL's engineering results database used by structural finite-element codes: open the .mili JSON root file, from which the plugin locates the per-processor state files. The output is a multiblock of unstructured meshes with materials and node and element results over time. ParaView 5.13.3 has no native Mili reader; the Mili plugin is an optional part of the VisIt bridge. One file supplies every time step the format stores.
  • pvVisItMirandaReader — Reads raw output of Miranda, LLNL's high-order hydrodynamics code for turbulent mixing, through its text .mir metadata file (gridfiles, datafiles, domainsize, blocksize, origin, spacing, variables, materials). The output is the block-decomposed "mesh" with the listed variables and material volume fractions over time. ParaView 5.13.3 has no native Miranda reader. One file supplies every time step the format stores.
  • pvVisItNASTRANReader — Reads NASTRAN bulk data decks (.nas) into one unstructured mesh named "mesh" with element groups as materials; no results are read. The native pvBDFReader reads NASTRAN bulk data in free format; this reader also handles fixed and large-field cards, so use it when the native reader rejects a deck. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItNek5000Reader — Reads Nek5000 spectral-element CFD output through its small metadata file (.nek3d, .nek5000, …) whose filetemplate, firsttimestep and numtimesteps lines locate the field dumps. The output is the element mesh with node-centred velocity, pressure, temperature and scalars over time. The native pvNek5000Reader reads the same metadata file into an unstructured grid and is distributed; prefer it for parallel runs. One file supplies every time step the format stores.
  • pvVisItNetCDFADAPTReader — Reads netCDF files written by ADAPT, an LLNL atmospheric modelling format that VisIt's netCDF plugin recognises by its specific variables. One file holds one time; a list of files forms a series. For netCDF following the CF/COARDS conventions the native pvNetCDFReader is the general choice. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItNetCDFCCSM_MTSDReader — Reads netCDF history files of the CCSM (Community Climate System Model) in which one file holds several time records; each record becomes a time step. Use pvVisItNetCDFCCSM_STSDReader when each file holds one time. The native pvNetCDFReader reads CF-compliant climate files with optional spherical coordinates and is usually the first choice. One file supplies every time step the format stores.
  • pvVisItNetCDFCCSM_STSDReader — Reads netCDF history files of the CCSM (Community Climate System Model) that hold one time record each; a list of files forms the time series. Use pvVisItNetCDFCCSM_MTSDReader when one file holds many records. The native pvNetCDFReader reads CF-compliant climate files and is usually the first choice. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItNetCDFFVCOMParticleReader — Reads Lagrangian particle-tracking files written by FVCOM (Finite-Volume Community Ocean Model): particle positions over time become a point mesh with per-particle quantities. The ocean fields themselves need pvVisItNetCDFFVCOM_MTSDReader, pvVisItNetCDFFVCOM_MTMDReader or pvVisItNetCDFFVCOM_STSDReader. One file supplies every time step the format stores.
  • pvVisItNetCDFFVCOM_MTMDReader — Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels through a master file that ties several domain files together (multi-time, multi-domain). Use pvVisItNetCDFFVCOM_MTSDReader for a single file with many times and pvVisItNetCDFFVCOM_STSDReader for one time per file. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. One file supplies every time step the format stores.
  • pvVisItNetCDFFVCOM_MTSDReader — Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels where one file holds many time records. Use pvVisItNetCDFFVCOM_MTMDReader for multi-domain master files and pvVisItNetCDFFVCOM_STSDReader for one time per file. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. One file supplies every time step the format stores.
  • pvVisItNetCDFFVCOM_STSDReader — Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels where each file holds one time; a list of files forms the series. Use pvVisItNetCDFFVCOM_MTSDReader when one file holds many times. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItNetCDFLODIParticleReader — Reads netCDF particle files of LODI, LLNL's Lagrangian atmospheric dispersion model: particle positions over time become a point mesh with per-particle quantities and, where defined, source groups as materials. Gridded LODI concentrations need pvVisItNetCDFLODIReader. One file supplies every time step the format stores.
  • pvVisItNetCDFLODIReader — Reads gridded netCDF output of LODI, LLNL's Lagrangian atmospheric dispersion model, with several time records in one file. Particle files of the same model need pvVisItNetCDFLODIParticleReader; generic CF-compliant netCDF uses pvNetCDFReader. One file supplies every time step the format stores.
  • pvVisItOVERFLOWReader — Reads binary Fortran grid and solution files of NASA's OVERFLOW overset-grid CFD solver (.dat, .save): every overlapping curvilinear grid becomes a domain of "mesh" with node-centred solution variables. The native pvPLOT3DReader reads standard PLOT3D grid and solution files; use this reader for OVERFLOW's own files. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItOpenFOAMReader — Reads an OpenFOAM case through VisIt's OpenFOAM plugin (a variant of VTK's OpenFOAM reader): open the case's system/controlDict file. The output is a multiblock with the selected internal mesh, patches, zones and Lagrangian clouds, with fields over all time directories. Prefer foam (Schemaxis-curated, with checked defaults) or the native pvOpenFOAMReader, which handle decomposed cases and region selection; this reader is mainly a cross-check. One file supplies every time step the format stores.
  • pvVisItPATRANReader — Reads MSC PATRAN neutral files (.neu), ASCII packet files describing unstructured finite-element geometry: one unstructured mesh named "mesh" with element attributes as cell arrays and named components as materials. ParaView 5.13.3 has no native PATRAN reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItPFLOTRANReader — Reads HDF5 output of PFLOTRAN, the parallel subsurface flow and reactive-transport code: a rectilinear grid named "mesh" with cell-centred fields for every output time and material ids as materials. ParaView 5.13.3 has no native PFLOTRAN reader. One file supplies every time step the format stores.
  • pvVisItPLOT2DReader — Registers VisIt's PLOT3D plugin for 2-D .p2d grid files. Because the plugin's read options stay at their 3-D binary defaults and a .p2d name is neither a .vp3d meta file nor a .x/.q pair, it is not established that 2-D files are read correctly. Prefer the native pvPLOT3DReader, whose properties describe the file variant explicitly. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItPLOT3DReader — Reads NASA PLOT3D structured grid (.x) and solution (.q) files described by a VisIt .vp3d text meta file. The output is a curvilinear "mesh" with one domain per grid and node-centred solution variables. The native pvPLOT3DReader (properties for each variant) and pvPLOT3DMetaFileReader (JSON .p3d time series) are normally preferable. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItParaDiSTecplotReader — Reads the Tecplot-like text output of ParaDiS, LLNL's Parallel Dislocation Simulator: dislocation nodes and segments become point and polyline meshes with their quantities. For ParaDiS's own data files use pvVisItParaDisReader; general Tecplot ASCII uses pvTecplotReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItParaDisReader — Reads data files of ParaDiS, LLNL's Parallel Dislocation Simulator: dislocation segments, nodes and the derived meta-arms become line and point meshes, with Burgers-vector and arm classifications as materials and per-node and per-segment arrays. Use pvVisItParaDisTecplotReader for the Tecplot-like text output. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItPixieReader — Reads 2-D and 3-D HDF5 output of the Pixie3D extended-MHD code: rectilinear or curvilinear grids with node- and cell-centred fields over the stored time steps. ParaView 5.13.3 has no native Pixie reader. One file supplies every time step the format stores.
  • pvVisItPoint3DReader — Reads an ASCII table of x, y, z and data-value columns (.3D): every row becomes a point and every column a point array. The native route for such tables is pvCSVReader followed by pvTableToPoints, which also handles more columns and other delimiters. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItProteinDataBankReader — Reads Protein Data Bank files (.pdb, .ent) of macromolecular structures: atoms become a point mesh with numeric per-atom arrays (element, residue type and sequence, backbone flag, occupancy, temperature factor). The native pvPDBReader produces molecule geometry for ball-and-stick rendering; choose this reader when you need the per-atom attributes as arrays. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItRAWReader — Reads the ASCII RAW triangle format used to exchange geometry with programs such as POV-Ray and Blender: each line is one triangle, grouped into named objects, giving a polygonal surface mesh "mesh" with one domain per object and no variables. It is not a raw binary image reader; use pvImageReader for raw volumes. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItSAMRAIReader — Reads output of SAMRAI, LLNL's Structured Adaptive Mesh Refinement Application Infrastructure, through the .samrai summary file of each time step: patches on refinement levels become vtkOverlappingAMR when only "amr_mesh" is selected. Materials are converted; SAMRAI species are not. The captured ParaView summary ("Reads Specific Absorption Rate image volume files") is copied from pvVisItSARReader and is wrong. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItSARReader — Reads Specific Absorption Rate (SAR) image volumes (.sar): a 3-D rectilinear grid named "mesh" with one point array "SAR", the radio-frequency energy absorption per voxel. The plugin source documents no units, so treat values as stored in the file. Use pvVisItSAMRAIReader for SAMRAI AMR files despite the shared upstream description. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItSASReader — Reads binary Fortran SAS geometry and data files (.sasgeom with .sas/.sasdata): an unstructured mesh of assemblies and channels with cell arrays identifying each assembly and channel and a temperature field over time. The plugin source gives no further description of the producing code; ParaView has no other reader for it. One file supplies every time step the format stores.
  • pvVisItSiloReader — Reads LLNL Silo files (PDB or HDF5 driver): rectilinear and curvilinear quad meshes, unstructured UCD meshes, point meshes and CSG meshes (discretized), multi-block objects, variables and materials. Silo is the native format of many LLNL codes and of VisIt. ParaView 5.13.3 has no native Silo reader; this plugin is an optional part of the VisIt bridge. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItSpheralReader — Reads ASCII output of Spheral++, LLNL's smoothed-particle hydrodynamics code with coupled gravity: SPH nodes become point meshes with node-centred fields, and node lists are also offered as materials. ParaView 5.13.3 has no native Spheral reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItTFTReader — Intended for ASCII results of the TFT Fortran simulation code (.dat, .tft). The plugin publishes them as VisIt curves, but the bridge converts only meshes, so the output is probably empty; this has not been verified. For tabular text use pvCSVReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItTSurfReader — Reads GOCAD TSurf triangulated surfaces (geological horizons and faults; ASCII with a "GOCAD TSurf" header, vertex and triangle records) into one unstructured triangle mesh named "mesh" without variables. ParaView 5.13.3 has no native GOCAD reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItTecplotBinaryReader — Reads a subset of Tecplot's binary .plt format: ordered and finite-element zones become structured or unstructured blocks with their variables. ParaView's native pvTecplotReader reads only ASCII Tecplot, so this is the catalogue's reader for binary .plt files (SZL .szplt files are a different format). FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItTecplotReader — Reads a subset of ASCII Tecplot (.tec, .tp): ordered (IJK) and finite-element zones become structured or unstructured domains with their variables. The native pvTecplotReader (multiblock of zones) is normally preferable; use this reader when it rejects a file. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItTetradReader — Reads Tetrad HDF5 files (a format written for INEEL, now Idaho National Laboratory): a tetrahedral unstructured mesh named "mesh" with cell-centred variables over the stored time steps. ParaView 5.13.3 has no native Tetrad reader. One file supplies every time step the format stores.
  • pvVisItUNICReader — Reads HDF5 result files of UNIC, Argonne's unstructured-mesh neutron transport code: unstructured meshes with node- and cell-centred results. ParaView 5.13.3 has no native UNIC reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItVASPCHGCARReader — Reads VASP (Vienna Ab initio Simulation Package) charge-density files (CHGCAR or CHG; the reader matches names starting with CHG): the density on the unit-cell grid becomes a point array "charge", with atom and unit-cell meshes alongside. ParaView's pvVASPAnimationReader and pvVASPTessellationReader read different VASP files, not CHGCAR. One file supplies every time step the format stores.
  • pvVisItVASPOUTCARReader — Reads VASP (Vienna Ab initio Simulation Package) OUTCAR files (names starting with OUT): every ionic step becomes a time step of a point mesh of atoms with element and force components, plus the unit cell. Use pvVisItVASPPOSCARReader for a single structure and pvVisItVASPCHGCARReader for charge densities. One file supplies every time step the format stores.
  • pvVisItVASPPOSCARReader — Reads VASP (Vienna Ab initio Simulation Package) structure files (POSCAR, names starting with POS): atom positions become a point mesh with an element array, plus the unit cell. Listing several files gives a series. Use pvVisItVASPOUTCARReader for relaxation or dynamics trajectories. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItVelodyneReader — Reads HDF5 result files of Velodyne, Corvid Technologies' structural mechanics code (.vld, .rst): solid, shell, surface, particle and SPH meshes with materials and node and element results. It is unrelated to Velodyne lidar data; pvVelodyneAMRReader reads a different (XAMR AMR) format. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItVsReader — Reads HDF5 files annotated with VizSchema markup (.h5, .vsh5), the convention used by Tech-X simulation codes such as VSim/Vorpal to describe meshes, variables and particles. The output is a multiblock of the declared meshes with their variables. ParaView 5.13.3 has no native VizSchema reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVisItXYZReader — Reads XYZ molecular files (atom count, comment line, then element and x y z per atom, optionally more columns); several frames in one file become time steps of a point mesh with element and extra-column arrays. The native pvXYZReader produces a vtkMolecule for molecular rendering; choose this reader for frame-by-frame point data or extra columns. One file supplies every time step the format stores.
  • pvVisItXmdvReader — Reads XmdvTool .okc files, a simple ASCII format for multivariate records (header with variable count, names and ranges, then one record per line). Each record becomes a point whose coordinates are the first three variables, and every variable becomes an array. For general delimited tables pvCSVReader is the native route. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).
  • pvVolumeOfRevolution — Sweeps a 2-D (planar) dataset about an axis to create a 3-D unstructured grid: vertices become lines, lines become quadrilaterals and 2-D cells become volume cells, with point and cell data copied to each swept copy. Use it to build a 3-D volume from an axisymmetric simulation for visualization or export. The axis is given by AxisPosition and AxisDirection (ParaView default: the x axis through the origin) and the sweep by SweepAngle and Resolution. ParaView's own short description of this filter (elevation) is a copying error.
  • pvVoronoiMergeConnected — Merges the cells of a Voronoi tessellation that share the same global RegionId into single polyhedron cells (vtkPMergeConnected), turning per-particle Voronoi cells into one cell per connected region. Input is a multiblock of unstructured grids carrying RegionId on points and cells and a Volumes cell array, as produced by ParaView's cosmology Voronoi tools; output is a multiblock with merged polyhedra, RegionId and summed Volumes. pvMinkowskiFilter can then characterize the shapes.
  • pvVortexCores — Extracts vortex core lines with the parallel-vectors method: lines where velocity is parallel to acceleration (or to jerk with UseHigherOrderMethod). Candidate cells are prefiltered with the Q and delta criteria, and the output polylines carry q-criterion, delta-criterion, lambda_2-criterion, lambda_ci-criterion and vorticity_magnitude point arrays for further filtering. Only 3-D linear cells are processed and the vector field must be a 3-component point array. Use it to locate swirling-flow axes; for vortex regions rather than lines, compute Q or lambda2 with gradient and contour them.
  • pvWarpByScalar — Displaces each point along a direction by ScaleFactor × its scalar value: x' = x + ScaleFactor · s · n, with n the point normal when the input has normals and UseNormal is false, otherwise the constant Normal. XYPlane uses each point's z coordinate as s and warps along z (carpet plots). Polydata, structured and unstructured grids keep their type; image and rectilinear inputs become structured grids. Use it for elevation or carpet plots of a scalar on a surface; the curated warpScalar covers the common case.
  • pvWarpByVector — Displaces each point by ScaleFactor × a 3-component point vector (x' = x + ScaleFactor · v), e.g. structural displacements or mode shapes, to show the deformed shape. Polydata, structured and unstructured grids keep their type; image and rectilinear inputs become structured grids. Point and cell data pass through, but input normals are dropped because the geometry changed. The curated warpVector covers the common case.
  • pvWavefrontOBJReader — Reads Wavefront .obj geometry into polydata with polygons and lines, keeping normals and texture coordinates when the file provides them. Materials (.mtl) are not applied to the data. Use it for surface models exported by modelling or CAD tools; use readSTL for STL and pvglTFReader for glTF scenes.
  • pvWavelet — Generates image data over WholeExtent (spacing SubsampleRate, origin 0) with the point scalar "RTData" = Maximum·exp(-r²/(2·StandardDeviation²)) + XMag·sin(XFreq·x) + YMag·sin(YFreq·y) + ZMag·cos(ZFreq·z), where x, y, z are offsets from Center divided by the extent width on each axis and r is their length. It is ParaView's standard synthetic volume, used to test contouring, slicing, volume rendering and exports. The curated wavelet operation offers Schemaxis defaults.
  • pvWindBladereader — Reads WindBlade/Firetec simulations (wind over terrain, turbines or wildfire spread) through an ASCII .wind file that describes the data files, grid sizes and variables, one data file per time step. Output port 0 is the wind field (structured grid), port 1 the turbine blades (an unstructured grid, when turbines are used) and port 2 the ground topology (structured grid); select a port with {"node": id, "port": n}.
  • pvWriteCGNSWriter — Explicit-export writer for CGNS (.cgns), the CFD General Notation System read by many solvers, meshers and post-processors. It accepts structured grids, polygonal data, unstructured grids, or a multiblock containing these, and stores mesh and point/cell solution fields in one file, using HDF5 storage by default (UseHDF5) or the older ADF layout. Publication uses the semantic contract: ParaView re-reads the file and geometry plus every input point and cell field are compared, accepting changes in block structure, point identity, connectivity order and storage type. Use it to hand results to CGNS-based tools; use pvWriteXMLUnstructuredGridWriter or pvWriteXMLMultiBlockDataWriter when the data only needs to round-trip through VTK.
  • pvWriteCSVWriter — Explicit-export writer that turns one dataset, composite dataset or table into delimited text (.csv, .txt or .tsv): one row per point, cell or table row and one column per array component, optionally with point coordinates (AddMetaData) and time columns. Use it to hand values to spreadsheets, pandas or R; mesh topology is not kept. Publication uses the table contract: Schemaxis re-reads the file and checks the row count and every input array of the written association within the export tolerance, accepting the loss of topology, coordinates and structure.
  • pvWriteDataSetCSVWriter — Legacy alias of pvWriteCSVWriter: ParaView keeps DataSetCSVWriter, a proxy derived from CSVWriter with the same class and settings, only for old state files and traces. It writes the same delimited text (one row per point, cell or table row, one column per component) and is verified the same way under the table contract. Prefer pvWriteCSVWriter in new documents.
  • pvWriteDataSetWriter — Explicit-export writer for the legacy VTK format (.vtk), the original single-file VTK layout still read by ParaView, VisIt, many solver converters and simple scripts. It writes one non-composite dataset of any mesh type, a table or a graph, in binary by default or ASCII (FileType). Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match the input exactly. Prefer scene geometry or the VTK XML writers (pvWriteXMLUnstructuredGridWriter, pvWriteXMLPolyDataWriter, ...) for new work, and use this writer when a downstream tool reads only legacy .vtk files.
  • pvWriteEnSightWriter — Explicit-export writer for EnSight Gold, the case format read by Ansys EnSight and many CFD post-processors: a .case index, a binary .geo geometry file and one file per point or cell array. It accepts only a single, non-composite unstructured grid; cells are grouped into EnSight parts by an integer BlockId cell array when present, otherwise everything is part 1. Publication uses the semantic contract: the case is read back and geometry plus every input point and cell field are compared, accepting changes in structure, point identity, connectivity order and storage type. Use pvWriteXMLUnstructuredGridWriter for lossless VTK storage, or pvWriteCGNSWriter / pvWriteIOSSWriter for other solver formats.
  • pvWriteExodusIIWriter — Explicit-export writer that saves a dataset or composite dataset as an Exodus II file (.e, .g, .ex2 …), the finite-element results format of the SEACAS tools. vtkExodusIIWriter writes each leaf's cells as unstructured elements grouped into element blocks; when the input carries no Exodus metadata (it did not come from an Exodus reader) it creates one block per cell type. Publication uses the semantic contract: the file is reopened and mesh geometry and every input field are compared, while block structure, point identity, connectivity order and storage type may change. Use pvWriteIOSSWriter for the IOSS path, or VTK XML output when Exodus is not required.
  • pvWriteGenericIOWriter — Explicit-export writer that saves a multiblock of particle unstructured grids as one HACC GenericIO file (.gio), each block becoming one rank's data (vtkPGenericIOMultiBlockWriter). Point coordinates are written as double variables x, y, z, single-component point arrays keep their names and 3-component arrays become <name>_x, _y and _z; cells and connectivity are not stored. Schemaxis verifies it with the semantic comparison, accepting structure and storage changes.
  • pvWriteHoudiniWriter — Explicit-export writer for the ASCII Houdini geometry format (.geo, pre-version-12 PGEOMETRY V2), for taking surfaces into SideFX Houdini for effects or rendering. The input must be polygonal data; point arrays become point attributes, cell arrays primitive attributes, and triangle strips are split into triangles. Schemaxis verifies geometry only, with its own parser of the writer's exact grammar (vertices, lines, polygons, triangle strips, attribute brackets, and NPrims counting emitted triangles): points and primitives are compared with the triangulated input surface, accepting loss of fields, point identity, interior cells and structure. Use pvWritePOBJWriter or pvWritePSTLWriter for more widely read surface formats.
  • pvWriteHyperTreeGridWriter — Explicit-export writer for VTK's hyper tree grid XML format (.htg), which stores adaptive tree-based meshes (vtkHyperTreeGrid: a coarse grid of quadtrees or octrees) with their refinement trees, masks, coordinates and cell fields. The input must be one non-composite hyper tree grid; all its arrays are written. Publication uses the exact contract: ParaView re-reads the file and tree structure, masks, coordinates and cell arrays must match exactly. Use pvWriteSerialHTGMultiBlock for a multiblock of hyper tree grids; this is also the format scene geometry chooses for hyper tree grids.
  • pvWriteIOSSWriter — Explicit-export writer for Exodus II (.exo) through the IOSS library, the finite-element format of Sandia's SIERRA codes, Cubit and many structural and multiphysics solvers. It accepts a dataset, a partitioned dataset or a partitioned dataset collection; every partition becomes an element block unless selectors (or, for data read by ParaView's IOSS reader, its IOSS assembly) assign partitions to blocks and sets, and a time-dependent input is exported for the one scheduled time step: Schemaxis manages TimeStepRange and TimeStepStride, because the writer otherwise loops over every input time step itself. Publication uses the semantic contract: the file is re-read and geometry plus every input point and cell field are compared, accepting loss of structure, point identity, connectivity order and storage type. Use pvWriteExodusIIWriter for ParaView's older Exodus writer and pvWriteCGNSWriter for CGNS tools.
  • pvWriteJPEGWriter — Explicit-export writer that saves image data (vtkImageData) as a JPEG (.jpg) file: 1 to 3 components of unsigned char values, compressed lossily at VTK's quality 95. Publication uses the pixels contract, comparing dimensions, components and values after re-reading, so a positive export tolerance is required (zero is rejected at planning) and pvWritePNGWriter is the choice for exact pixels.
  • pvWriteJSONImageWriter — Explicit-export writer that saves a uniform image (vtkImageData) node as a JSON document listing the image dimensions, origin, spacing and the values of its point arrays, for web or scripting tools rather than for re-reading in ParaView. Use it as an export writer with comparison "pixels": Schemaxis then parses the JSON itself and checks dimensions, origin, spacing and exactly the arrays the writer emits against the source image: one-component point arrays other than vtkValidPointMask, narrowed by ArrayName and Slice, with null where vtkValidPointMask is 0. The input must be non-composite image data; resample other datasets to an image first. For standard raster formats use pvWritePNGWriter, pvWriteTIFFWriter or pvWriteMetaImageWriter.
  • pvWriteMetaImageWriter — Explicit-export writer for MetaImage (.mhd): a short text header (dimensions, spacing, element type) plus a separate binary data file, the format read by ITK-based medical-imaging and segmentation tools. The input must be one non-composite vtkImageData; VTK writes the image scalars and compresses the data file by default. Schemaxis publishes it under the pixels contract: the file is read back and dimensions, component count and scalar values are compared, while coordinates and other fields are accepted as lost. Use pvWriteTIFFWriter or pvWritePNGWriter for 2-D raster interchange, or automatic VTK XML image output (.vti) to keep all arrays.
  • pvWriteOpenVDBWriter — Explicit-export writer for OpenVDB (.vdb), the sparse volume format used by Houdini, Blender and film-style renderers. It accepts non-composite image data (volumes) or point sets (meshes or point clouds handled through their points); with EnableColoring it adds a colour channel, and with EnableAlpha an alpha channel, computed from a lookup table supplied through the export's LookupTable resource. The declared publication uses the exact contract, comparing ParaView's readback of the .vdb with the input. Use it to send simulation volumes to rendering tools; keep pvWriteXMLImageDataWriter for lossless analysis data.
  • pvWritePDataSetWriterPolyData — Legacy VTK (.vtk) writer for polygonal data built on ParaView's parallel-serial writer, which in an MPI run gathers all pieces to one or a few ranks (NumberOfIORanks) and writes a single file. Schemaxis runs explicit exports serially, so the result is the same single binary-by-default legacy file that pvWriteDataSetWriter produces for a polydata. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match exactly. Prefer pvWriteDataSetWriter, which accepts any dataset type, or pvWriteXMLPolyDataWriter for the modern XML format.
  • pvWritePDataSetWriterUnstructuredGrid — Legacy VTK (.vtk) writer for unstructured grids built on ParaView's parallel-serial writer, which in an MPI run gathers all pieces to one or a few ranks (NumberOfIORanks) and writes a single file. Schemaxis runs explicit exports serially, so the result is the same single binary-by-default legacy file that pvWriteDataSetWriter produces for a unstructured grid. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match exactly. Prefer pvWriteDataSetWriter, which accepts any dataset type, or pvWriteXMLUnstructuredGridWriter for the modern XML format.
  • pvWritePNGWriter — Explicit-export writer that stores image data (vtkImageData) as PNG, a lossless raster format holding 1 to 4 components of unsigned char (8-bit) or unsigned short (16-bit) values. It suits masks, label images and already-quantized images, not floating-point simulation fields; this writes data values, unlike a rendered scene image. Publication uses the pixels contract: the PNG is read back and its dimensions, components and values are compared with the input scalars. Use pvWriteTIFFWriter for 32-bit float data.
  • pvWritePOBJWriter — Explicit-export writer for Wavefront OBJ (.obj), a plain-text surface format read by almost every 3-D modelling, rendering and visualization tool. It writes the points, lines, triangles and polygons of polygonal data plus point normals and texture coordinates when present; solution fields are not stored. TextureFileName additionally writes a material (.mtl) file that refers to an existing texture image. Publication uses the geometry contract: the file is read back and the triangulated surface is compared, accepting loss of fields, point identity, interior cells and structure. Use pvWritePSTLWriter for triangle-only CAD or 3-D printing exchange, and VTK XML writers when fields matter.
  • pvWritePPLYWriter — Explicit-export writer for Stanford PLY (.ply): polygonal surface geometry (points and polygons) for mesh, 3-D printing and point-cloud tools, binary by default (FileType). It accepts polygonal data only, so extract a surface first (pvExtractSurface). Field arrays are not carried, except optional per-point or per-cell RGB(A) colours written when EnableColoring is true, ColorArrayName names the array and a lookup-table resource is attached to the export. Publication uses the geometry contract: Schemaxis re-reads the file with ParaView's PLY reader and compares the triangulated surface within the tolerance.
  • pvWritePSTLWriter — Explicit-export writer for STL (.stl), the triangle-only surface format used by 3-D printing, CAD and meshing tools (for example as snappyHexMesh geometry). It writes binary STL by default or ASCII with FileType; only triangles are stored, with no units or fields. Publication uses the geometry contract: the file is re-read and its triangles are compared with the triangulated input surface within the tolerance, accepting loss of fields, point identity, interior cells and structure. Use pvWritePOBJWriter to keep polygons and normals, or pvWritePPLYWriter for per-vertex attributes.
  • pvWriteSerialHTGMultiBlock — Explicit-export writer that saves a multiblock dataset whose blocks are hyper tree grids as a VTK multiblock file (.vtm) plus one .htg file per block in a data/ subfolder. ParaView marks its input as composite-only (the input contract records composite as "required"): the node must output a multiblock of hyper tree grids. Publication uses the exact contract: ParaView re-reads the .vtm and the block structure, trees and cell arrays must match exactly. Use pvWriteHyperTreeGridWriter for a single hyper tree grid.
  • pvWriteTIFFWriter — Explicit-export writer that saves image data (vtkImageData) as TIFF. vtkTIFFWriter accepts unsigned char, unsigned short or float scalars, so unlike PNG it can store 32-bit floating-point fields such as a sampled temperature image. Scalars selects which point array becomes the image values. Publication uses the pixels contract: the TIFF is read back and dimensions, components and values are compared; coordinates and other arrays are not preserved.
  • pvWriteVTKHDFWriter — Explicit-export writer for VTKHDF (.vtkhdf), VTK's HDF5-based single-file format, suited to large meshes and to parallel or partial reading. In ParaView 5.13.3 it accepts unstructured grids, polygonal data, partitioned dataset collections and multiblock datasets. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match the input exactly. Use it for compact archives of large meshes; the VTK XML writers (for example pvWriteXMLUnstructuredGridWriter) remain the most widely supported VTK format.
  • pvWriteXMLHierarchicalBoxDataWriter — Deprecated ParaView name for the VTK XML AMR writer: it saves overlapping AMR data (vtkHierarchicalBoxDataSet, i.e. refinement levels of uniform image blocks) as a .vthb index plus one .vti file per block in a data/ subfolder. ParaView 5.13.3 marks it deprecated in favour of pvWriteXMLUniformGridAMRWriter, which takes the same settings and is the better choice for new documents. Publication uses the exact contract: ParaView re-reads the .vthb (Schemaxis requests every level) and levels, boxes, origins and arrays must match exactly.
  • pvWriteXMLImageDataWriter — Explicit-export writer for VTK XML image data (.vti): a uniform grid (origin, spacing, dimensions, direction) with all point, cell and field arrays, stored losslessly in one file. Scene geometry already chooses this format automatically for image data; use this writer for explicit DataMode or compression control or several exports of one node. Publication uses the exact contract: ParaView re-reads the file and extent, origin, spacing, direction and every array must match exactly. Use pvWriteXMLPImageDataWriter for the parallel .pvti layout, and pvWriteTIFFWriter or pvWritePNGWriter for raster interchange.
  • pvWriteXMLMultiBlockDataWriter — Explicit-export writer for VTK XML multiblock data (.vtm): an index describing the block tree (names and nesting) plus one VTK XML file per leaf dataset in a data/ subfolder, keeping every array. Scene geometry uses the same format automatically for multiblock outputs; choose this writer for explicit storage settings or block selection. Publication uses the exact contract: ParaView re-reads the .vtm and block structure, names, geometry and arrays must match exactly. Use pvWriteXMLPartitionedDataSetCollectionWriter for partitioned collections and pvWriteIOSSWriter or pvWriteCGNSWriter for solver interchange.
  • pvWriteXMLPHyperTreeGridWriter — Parallel-layout writer for hyper tree grids: a .phtg summary file that lists one .htg piece per process. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the summary and trees, masks and cell arrays must match exactly. Prefer pvWriteHyperTreeGridWriter, which writes the same data as one self-contained .htg file.
  • pvWriteXMLPImageDataWriter — Explicit-export writer for the parallel VTK XML layout of image data (uniform grids with origin, spacing and extent): a small .pvti summary file listing one .vti piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvti and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvti layout; otherwise pvWriteXMLImageDataWriter or scene geometry gives one self-contained .vti file.
  • pvWriteXMLPPartitionedDataSetWriter — Explicit-export writer for VTK XML partitioned datasets (.vtpd): an index plus one VTK XML file per partition (each partition a dataset of its own type) in a data/ subfolder, keeping every partition's geometry and arrays. Scene geometry uses the same format automatically for partitioned datasets; choose this writer for explicit storage settings. Publication uses the exact contract: ParaView re-reads the .vtpd and partitions, geometry and arrays must match exactly. Use pvWriteXMLPartitionedDataSetCollectionWriter for collections of partitioned datasets and pvWriteXMLMultiBlockDataWriter for multiblock data.
  • pvWriteXMLPPolyDataWriter — Explicit-export writer for the parallel VTK XML layout of polygonal data (surfaces, lines and points): a small .pvtp summary file listing one .vtp piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtp and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtp layout; otherwise pvWriteXMLPolyDataWriter or scene geometry gives one self-contained .vtp file.
  • pvWriteXMLPRectilinearGridWriter — Explicit-export writer for the parallel VTK XML layout of rectilinear grids (axis-aligned grids with separate x, y and z coordinate arrays): a small .pvtr summary file listing one .vtr piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtr and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtr layout; otherwise pvWriteXMLRectilinearGridWriter or scene geometry gives one self-contained .vtr file.
  • pvWriteXMLPStructuredGridWriter — Explicit-export writer for the parallel VTK XML layout of structured grids (curvilinear i-j-k grids with explicit point coordinates): a small .pvts summary file listing one .vts piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvts and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvts layout; otherwise pvWriteXMLStructuredGridWriter or scene geometry gives one self-contained .vts file.
  • pvWriteXMLPTableWriter — Explicit-export writer for the parallel VTK XML layout of tables (rows of named columns): a small .pvtt summary file listing one .vtt piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtt and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtt layout; otherwise pvWriteXMLTableWriter or scene geometry gives one self-contained .vtt file.
  • pvWriteXMLPUnstructuredGridWriter — Explicit-export writer for the parallel VTK XML layout of unstructured grids (meshes of arbitrary cell types): a small .pvtu summary file listing one .vtu piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtu and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtu layout; otherwise pvWriteXMLUnstructuredGridWriter or scene geometry gives one self-contained .vtu file.
  • pvWriteXMLPVDWriter — Explicit-export writer for ParaView's PVD format: a small XML .pvd index plus the VTK XML piece file(s) it references (type chosen from the data, e.g. .vtu or .vtp), written into a subdirectory named after the file, for one time step. It accepts a single non-composite dataset or table. Publication uses the exact contract: the .pvd is reopened and structure, connectivity, values and storage types must match the input. Choose it when the recipient expects a .pvd collection; otherwise a single-file pvWriteXML…Writer is simpler.
  • pvWriteXMLPartitionedDataSetCollectionWriter — Explicit-export writer for VTK XML partitioned dataset collections (.vtpc): an index plus one VTK XML file per partition in a data/ subfolder, keeping the collection's partitioned datasets, names, data assembly and arrays. Scene geometry uses the same format automatically for collections (for example multi-region readers' output); choose this writer for explicit storage settings or block selection. Publication uses the exact contract: ParaView re-reads the .vtpc and the partitions, names, assembly and arrays must match exactly. Use pvWriteXMLMultiBlockDataWriter for multiblock data.
  • pvWriteXMLPolyDataWriter — Explicit-export writer that saves a polygonal (vtkPolyData) node, such as a slice, contour, extracted surface, lines or points, as a VTK XML PolyData file (.vtp) with its geometry, connectivity and point, cell and field arrays. Schemaxis reopens the file and requires an exact match of structure, connectivity, values and storage types, so the .vtp is a lossless copy of the node. Automatic geometry output already writes .vtp for polydata; choose this writer when you need to control the encoding (DataMode, CompressorType) or want an export receipt. Use pvWriteXMLUnstructuredGridWriter for volume meshes and pvWriteXMLMultiBlockDataWriter for composite data.
  • pvWriteXMLRectilinearGridWriter — Explicit-export writer that saves a rectilinear grid (vtkRectilinearGrid: a structured grid with independent, possibly non-uniform, coordinate arrays along x, y and z) as a VTK XML RectilinearGrid file (.vtr), keeping the extent, the three coordinate arrays and all point, cell and field arrays. Schemaxis verifies the reopened file with an exact comparison. Automatic geometry output already writes .vtr for this type; use this writer to control encoding or to get an explicit export receipt. For uniform spacing the data are usually image data (pvWriteXMLImageDataWriter); for curvilinear grids use pvWriteXMLStructuredGridWriter.
  • pvWriteXMLStructuredGridWriter — Explicit-export writer that saves a curvilinear structured grid (vtkStructuredGrid: i-j-k topology with explicit point coordinates, typical of body-fitted CFD blocks) as a VTK XML StructuredGrid file (.vts), with extent, points and all point, cell and field arrays. The reopened file must match the node exactly. Automatic geometry already writes .vts for this type; choose this writer for encoding control or an explicit export receipt. Use pvWriteXMLRectilinearGridWriter for axis-aligned grids and pvWriteXMLUnstructuredGridWriter for general meshes.
  • pvWriteXMLTableWriter — Explicit-export writer that saves a table (vtkTable), such as probe-over-line, integration or statistics results, as a VTK XML Table file (.vtt) that keeps every column with its name, type and component count. Unlike pvWriteCSVWriter it is binary-capable and lossless, and Schemaxis verifies the reopened file with an exact comparison. Automatic geometry output already writes .vtt for tables; choose this writer for encoding control or an explicit export receipt. The input must be a single table, not a dataset with point or cell data.
  • pvWriteXMLUniformGridAMRWriter — Explicit-export writer for adaptive-mesh-refinement data (vtkUniformGridAMR, overlapping or non-overlapping): it writes a .vthb index file plus one VTK XML image file per AMR block in a companion folder, keeping levels, refinement ratios, block extents and all arrays. Schemaxis reopens the set (asking the reader for all levels) and requires an exact match. Automatic geometry already writes .vthb for overlapping AMR; choose this writer for encoding or header-size control or an explicit export receipt. pvWriteXMLHierarchicalBoxDataWriter is the deprecated name of the same format.
  • pvWriteXMLUnstructuredGridWriter — Explicit-export writer that saves an unstructured grid (vtkUnstructuredGrid: arbitrary cells such as tetrahedra, hexahedra, prisms or polyhedra, the usual output of clip, threshold, merge and many mesh readers) as a VTK XML UnstructuredGrid file (.vtu) with points, cells and all point, cell and field arrays. Schemaxis reopens the file and requires an exact match. Automatic geometry already writes .vtu for this type; choose this writer for encoding control or an explicit export receipt. Use pvWriteXMLPolyDataWriter for surfaces stored as polydata and pvWriteXMLMultiBlockDataWriter for composite data such as an OpenFOAM case.
  • pvWriteXdmf3Writer — Explicit-export writer for XDMF 3 (.xmf): an XML description of the mesh and arrays with large arrays in an HDF5 companion file, accepting datasets, composite data and graphs. Schemaxis writes one scheduled state and verifies it semantically: the readback must reproduce the mesh geometry and every input point and cell field, while block structure, point identity, connectivity order and storage type may change. Use it for exchange with XDMF 3 tools; pvWriteXdmfWriter writes the older XDMF 2 dialect.
  • pvWriteXdmfWriter — Explicit-export writer for XDMF 2 (.xmf): an XML description of the mesh and arrays, with large arrays stored in an HDF5 file beside it. Schemaxis writes one scheduled state per export and verifies it semantically: the file is read back and the mesh geometry and every input point and cell field must match, while block structure, point identity, connectivity order and storage type may change. Use it to hand results to XDMF-aware tools; pvWriteXdmf3Writer writes the newer XDMF 3 dialect with array selection.
  • pvXDMFReader — Reads XDMF 2 files (.xmf/.xdmf): XML metadata with heavy arrays in HDF5. The output is the file's grid type (unstructured, structured or rectilinear) or a multiblock when it has several grids. Several file names form a file series read as time steps. Selections choose which grids, sets and point or cell arrays are loaded, and Stride subsamples structured grids. It is a distributed reader. pvXdmf3ReaderT and pvXdmf3ReaderS read XDMF 3 files.
  • pvXMLHierarchicalBoxDatareader — Reads VTK XML hierarchical-box AMR files (.vthb, .vth) in the version 1.0 or older layout: a summary file referring to vtkUniformGrid pieces at several refinement levels, read as an overlapping AMR dataset. For the newer layout use pvXMLUniformGridAMRReader, which also offers array selection and a level limit. Several summary files form a time series.
  • pvXMLImageDataReader — Reads VTK XML image data files (.vti) into image data (vtkImageData): a uniform grid defined by origin, spacing and extent, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readImageData for the simple single-file case and pvXMLPartitionedImageDataReader for .pvti pieces.
  • pvXMLMultiBlockDataReader — Reads VTK XML multiblock files (.vtm, .vtmb) into a multiblock dataset whose named blocks are read from the serial VTK XML files the .vtm meta file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readMultiBlock for the simple single-file case; PieceDistribution only matters in parallel.
  • pvXMLPartitionedDatasetCollectionReader — Reads VTK XML partitioned dataset collection files (.vtpc) into a partitioned dataset collection: several datasets, each split into partitions, with an optional assembly hierarchy, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLMultiBlockDataReader for .vtm files and pvXMLPartitionedDatasetReader for one partitioned dataset (.vtpd).
  • pvXMLPartitionedDatasetReader — Reads VTK XML partitioned dataset files (.vtpd) into a partitioned dataset: one dataset split into partitions read from the serial VTK XML files the .vtpd meta file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLPartitionedDatasetCollectionReader for .vtpc collections of several datasets.
  • pvXMLPartitionedHyperTreeGridReader — Reads partitioned VTK XML hypertree grid data: a .phtg summary file and the .htg piece files it lists, assembled into a hypertree grid (adaptive tree-based AMR mesh). Several summary files form a time series. Use pvHyperTreeGridReader for a single .htg file, which also offers a level limit and a selection box.
  • pvXMLPartitionedImageDataReader — Reads partitioned VTK XML image data files (.pvti) into image data (vtkImageData) assembled from the .vti pieces the .pvti summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLImageDataReader or readImageData for a single .vti file.
  • pvXMLPartitionedPolydataReader — Reads partitioned VTK XML polydata files (.pvtp) into polydata assembled from the .vtp pieces the .pvtp summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readParallelPolyData for the simple single-file case and pvXMLPolyDataReader for one .vtp file.
  • pvXMLPartitionedRectilinearGridReader — Reads partitioned VTK XML rectilinear grid files (.pvtr) into a rectilinear grid (axis-aligned, with per-axis coordinate arrays) assembled from the .vtr pieces the .pvtr summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLRectilinearGridReader or readRectilinearGrid for a single .vtr file.
  • pvXMLPartitionedStructuredGridReader — Reads partitioned VTK XML structured grid files (.pvts) into a structured (curvilinear) grid assembled from the .vts pieces the .pvts summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLStructuredGridReader or readStructuredGrid for a single .vts file.
  • pvXMLPartitionedTableReader — Reads partitioned VTK XML table data: a .pvtt summary file and the .vtt piece files it lists, assembled into one table (vtkTable) of named columns with no geometry. Several summary files form a time series. Use pvXMLTableReader for one .vtt file and pvCSVReader for text tables.
  • pvXMLPartitionedUnstructuredGridReader — Reads partitioned VTK XML unstructured grid files (.pvtu) into an unstructured grid assembled from the .vtu pieces the .pvtu summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readParallelUnstructuredGrid for the simple single-file case and pvXMLUnstructuredGridReader for one .vtu file.
  • pvXMLPolyDataReader — Reads VTK XML polydata files (.vtp) into polydata: surfaces, lines and vertices, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readSurface for the simple single-file case and pvXMLPartitionedPolydataReader for .pvtp pieces.
  • pvXMLRectilinearGridReader — Reads VTK XML rectilinear grid files (.vtr) into a rectilinear grid (axis-aligned, with per-axis coordinate arrays), with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readRectilinearGrid for the simple single-file case and pvXMLPartitionedRectilinearGridReader for .pvtr pieces.
  • pvXMLStructuredGridReader — Reads VTK XML structured grid files (.vts) into a structured (curvilinear) grid with explicit point coordinates, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readStructuredGrid for the simple single-file case and pvXMLPartitionedStructuredGridReader for .pvts pieces.
  • pvXMLTableReader — Reads a VTK XML table file (.vtt): a vtkTable of named columns with no geometry, such as values exported by an extract-attributes or statistics step. The output is a table, so use it for plotting, statistics or CSV-style export rather than for rendering or spatial filters. Several files (or a .vtt.series file) form a time series with one file per time step. For geometry use readSurface, readUnstructuredGrid or the other VTK XML readers.
  • pvXMLUniformGridAMRReader — Reads a VTK XML overlapping or non-overlapping AMR file (.vthb, or the older .vth): a hierarchy of refinement levels made of uniform-grid blocks, as written by AMR codes or by ParaView. The output is a vtkOverlappingAMR or vtkNonOverlappingAMR composite dataset. ParaView reads only DefaultNumberOfLevels levels unless a downstream filter asks for more, and its default is 1, so by default only the coarsest level is loaded. Use pvAMRGaussianPulseSource for a synthetic AMR test dataset.
  • pvXMLUnstructuredGridReader — Generated binding of ParaView's XML Unstructured Grid Reader: reads VTK XML unstructured grid files (.vtu) holding arbitrary cells (tetrahedra, hexahedra, polyhedra, mixed) with point and cell arrays, and outputs a vtkUnstructuredGrid. Unlike the curated readUnstructuredGrid (one file, every array), it accepts a list of files read as a time series and lets you choose which point and cell arrays to load. Use readParallelUnstructuredGrid for partitioned .pvtu output.
  • pvXYZReader — Reads an XYZ molecular file (.xyz: atom count, comment line, then element symbol and x y z per atom) into a vtkMolecule; files with several consecutive frames become time steps. Bonds are not stored in the format; use pvComputeMoleculeBonds to derive them and pvMoleculeToLines to obtain polydata for general filters. Use pvPDBReader or pvCMLMoleculeReader for formats that carry more chemistry.
  • pvXdmf3ReaderS — Reads XDMF 3 files (.xmf/.xdmf) with heavy data in HDF5. A single domain with one grid gives that dataset type; otherwise the output is a multiblock. This variant treats a series of files as spatial partitions of one dataset (top-level partitioning) (AsTime false by default). Point and cell arrays and named sets can be selected. Use pvXdmf3ReaderT for the other file-series interpretation and pvXDMFReader for XDMF 2 files.
  • pvXdmf3ReaderT — Reads XDMF 3 files (.xmf/.xdmf) with heavy data in HDF5. A single domain with one grid gives that dataset type; otherwise the output is a multiblock. This variant treats a series of files as successive time steps (AsTime true by default). Point and cell arrays and named sets can be selected. Use pvXdmf3ReaderS for the other file-series interpretation and pvXDMFReader for XDMF 2 files.
  • pvYieldCriteria — Evaluates yield criteria of selected symmetric stress tensors from their principal values σ1 ≥ σ2 ≥ σ3: Tresca as |σ3 − σ1| and von Mises as √(((σ1 − σ2)² + (σ2 − σ3)² + (σ1 − σ3)²) / 2), stored as <name> - Tresca Criterion and <name> - Von Mises Criterion in the tensor's units. The Principal Stress choice also keeps the principal value and direction arrays. Use it in structural post-processing to compare stress states with a material's yield strength. Tensor requirements match pvTensorPrincipalInvariants (6 components XX, YY, ZZ, XY, YZ, XZ, or 3 named XX, YY, XY).
  • pvYoungsMaterialInterface — Reconstructs sharp material interfaces in mixed cells of Eulerian or ALE multi-material simulations (e.g. CTH or other volume-of-fluid output) with Youngs' method: in each cell the material is bounded by a plane perpendicular to its interface normal, placed so the cut volume matches the cell's volume fraction. Input is a composite dataset with one cell-centred volume fraction array per material and, ideally, a 3-component cell normal array per material. Output is a multiblock with one block per material (in VolumeFractionArrays order) holding the interface polygons or, with FillMaterial (ParaView default), the material's volume.
  • pva2DGlyph — Creates one flat 2-D marker in the x-y plane as polydata: vertex, dash, cross, thick cross, triangle, square, circle, diamond or one of four arrow styles (GlyphType, ParaView default Arrow), about one unit in size around Center. Use it as the glyph shape for 2-D vector or point-marker plots, or as an annotation symbol.
  • pva3DText — Creates polygonal (filled outline) geometry spelling Text in a vector font, lying in the x-y plane with the text starting near the origin and characters about one unit tall. It is real geometry, so it can be transformed, clipped or exported, unlike a screen-space text annotation. Use it to label parts of a 3-D scene.
  • pvglTFReader — Reads a glTF 2.0 asset (.gltf with external buffers, or binary .glb) into a multiblock dataset of polydata for one scene, with skinning, morph targets and enabled animations applied to the geometry when ApplyDeformationsToGeometry is true. Animations become time steps sampled at Framerate. Materials and textures are not applied. Use it to bring 3-D models or animated scenes into a pipeline; for static CAD surfaces pvWavefrontOBJReader or readSTL are simpler.
  • pvopenPMDReader — Reads an openPMD particle-mesh data series (plasma and accelerator simulations such as WarpX or PIConGPU) through a .pmd file: a text file whose first line is the openPMD file pattern, e.g. "data_%T.h5", resolved next to the .pmd file. Output port 0 is the mesh records as image data (a vtkPartitionedDataSet), port 1 the particle species as point clouds (a vtkPartitionedDataSetCollection, one per species); select it with {"node": id, "port": 1}. Values, coordinates and times are converted to SI using the openPMD unit factors.
  • pvproSTARSTARCDReader — Reads a proSTAR (STAR-CD) mesh stored as ASCII .vrt (vertices) and .cel (cells) files with a common base name into an unstructured grid; pass either file. ScaleFactor multiplies all coordinates, e.g. 0.001 to convert a millimetre mesh to metres. Only geometry is read, not solution fields.
  • pvspcthhistoryreader — Reads a CTH Spy Plot history file (.hscth, names matching hsct): delimited text in which each row is one time step and the columns hold tracer-point positions, materials and properties. The output is a table (vtkTable), with the rows exposed as time steps, suitable for plotting probe histories; it is not a mesh. Use pvSpyPlotReader for the field data itself.
  • readImageData — Reads one VTK XML image data file (.vti) into vtkImageData: a uniform grid defined by extent, origin and spacing, with point and cell arrays. Use it for voxel or pixel data such as sampled volumes, resampled CFD fields or images exported by ParaView; the result suits volume rendering, contouring and image filters. For curvilinear or irregular meshes use readStructuredGrid or readUnstructuredGrid.
  • readMultiBlock — Reads a VTK XML multiblock file (.vtm, or the older .vtmb): a small index file that names the serial VTK XML files of each block and nests them in a block hierarchy. The output is a vtkMultiBlockDataSet whose leaves may mix datasets of different types. Use it to reopen composite results such as a multi-region case saved by ParaView or Schemaxis; follow it with extractBlock to pick blocks or merge to combine them into one dataset.
  • readPLY — Curated PLY reader: reads exactly one Stanford PLY file (ASCII or binary) into polydata, with vertex properties such as normals, colours or texture coordinates carried as arrays. PLY has no unit, so coordinates are in whatever unit the scanner or CAD tool used. Use it for scanned or meshed surfaces to render, clip or probe; use pvPLYReader for file series or texture settings, and readSTL for STL.
  • readParallelPolyData — Reads a partitioned VTK XML polydata dataset: the .pvtp summary file plus the per-piece .vtp files it lists, typically written by an MPI run. The pieces are combined into polydata (surfaces, lines, vertices) with their point and cell arrays. Use it to reopen distributed surface output, including Schemaxis's own native parallel geometry; in Schemaxis MPI runs it is one of the operations qualified for distributed reading. Use readSurface for a single .vtp file.
  • readParallelUnstructuredGrid — Reads a partitioned VTK XML unstructured grid: the .pvtu summary file plus the per-piece .vtu files it lists, typically written by an MPI run. The result is an unstructured grid with the point and cell arrays of all pieces. Use it to reopen distributed volume output, including Schemaxis's native parallel geometry (examples/schemaxis/foam-native-parallel.json); it is in Schemaxis's MPI-qualified operation list. Use readUnstructuredGrid for a single .vtu file.
  • readRectilinearGrid — Reads one VTK XML rectilinear grid file (.vtr) into vtkRectilinearGrid: an axis-aligned structured grid whose x, y and z coordinates are given by three independent (possibly non-uniform) coordinate arrays. Use it for tensor-product meshes with graded spacing, e.g. stretched finite-difference grids. For uniform spacing readImageData is the lighter equivalent; for curved structured meshes use readStructuredGrid.
  • readSTL — Reads one ASCII or binary STL file into polydata made of triangles. STL stores only triangle geometry, with no units or field arrays, so coordinates are in whatever unit the exporting CAD tool used. Use it for CAD or scanned surfaces to render, clip against, or probe onto; add normals for smooth shading. Schemaxis reads exactly one file (no file series).
  • readStructuredGrid — Reads one VTK XML structured grid file (.vts) into vtkStructuredGrid: a curvilinear i-j-k grid with explicit point coordinates and implicit hexahedral (or quadrilateral) connectivity. Use it for body-fitted structured meshes, e.g. multi-block CFD grids exported block by block. For axis-aligned grids use readRectilinearGrid or readImageData; for arbitrary cells use readUnstructuredGrid.
  • readSurface — Reads one VTK XML polydata file (.vtp): polygonal surfaces, lines and vertices with point and cell arrays, such as extracted boundaries, slices or streamlines saved earlier. Use it to reopen surface artifacts, for instance in a later workflow that renders or measures them. Use readParallelPolyData for partitioned .pvtp output and readUnstructuredGrid for volume meshes.
  • readUnstructuredGrid — Reads one VTK XML unstructured grid file (.vtu) into vtkUnstructuredGrid, with any mix of cell types (tetrahedra, hexahedra, wedges, polyhedra) and all point and cell arrays. Use it to reopen volume meshes exported by Schemaxis, Gmsh or a solver; it is the reader covered by Schemaxis's reader fixture. Use pvXMLUnstructuredGridReader when you need array selection or a file series, and readParallelUnstructuredGrid for .pvtu output.
  • reflect — Mirrors the input across an axis-aligned plane and outputs an unstructured grid (a composite input gives a multiblock of unstructured grids) holding the mirrored copy, plus the original when copyInput is true. Use it to rebuild a full model from a half- or quarter-symmetry simulation, or to mirror a part for display. The plane is x, y or z = centre (Schemaxis default plane X at 0) or one face of the input's bounding box (X Min to Z Max). Vector and tensor arrays such as velocity are mirrored with the geometry because ParaView's FlipAllInputArrays stays at its default (on); scalars are copied unchanged.
  • resample — Samples the arrays of the input node (port input, native SourceDataArrays) at the points of the mesh node (port mesh, native DestinationMesh). The result has the mesh's geometry with the input's point and cell values interpolated to its points and a vtkValidPointMask array; with passPointArrays (Schemaxis default true) the mesh's own point arrays are kept too. Use it to compare or combine results on a common mesh, e.g. map a CFD field onto a measurement or structural mesh; pvResampleWithDataset exposes the remaining native settings.
  • shrink — Moves the points of every cell towards that cell's centroid (the average of its points) so that cells separate from their neighbours, and outputs an unstructured grid in which no point is shared between cells. It is a mesh-inspection aid that reveals cell shapes, sizes and gaps inside a volume or surface mesh; point and cell arrays travel with the cells. factor is the fraction of each cell's size kept (Schemaxis default 0.8; ParaView's own default is 0.5).
  • slice — Cuts the input with one infinite plane through origin, perpendicular to normal, and returns polygonal data: a surface from a volume mesh, lines from a surface. Point arrays are interpolated onto the cut and cell arrays are copied from the cell each polygon came from, so cell-centred CFD fields appear piecewise constant. Use it for cross-sections of 3-D fields; use clip to keep one side of a volume, contour for an isosurface, probeLine for a 1-D profile, and pvSlice for several parallel offsets or other cut shapes.
  • smooth — Applies Laplacian smoothing to a polygonal surface: each iteration moves every point a small step towards the average of its connected neighbours. The output is polygonal data with the same points and connectivity at smoother positions, and arrays are passed unchanged. Use it to reduce faceting or noise on scanned, marching-cubes or STL surfaces before rendering or curvature. Input must be vtkPolyData; run surface first on volume meshes.
  • sphere — Creates a triangulated polygonal sphere (vtkPolyData with point normals) of given radius about centre, with its poles on the z axis. resolution sets the number of longitude divisions around z (Schemaxis default 24, ParaView's own default 8); latitude divisions are fixed at 24 by Schemaxis. Use it as a marker, a target mesh for resample, a seed surface for streamTracer or simple test geometry; its coordinates are in the units of the data it is combined with.
  • streamTracer — Integrates streamlines of a steady vector field from the points of a separate seed dataset and returns polygonal data made of polylines. Connect the flow dataset to input and any point-producing node (line, sphere, a slice) to seed; every seed point starts a trace. Input point arrays are interpolated onto the lines and ParaView adds IntegrationTime, Vorticity, Rotation and AngularVelocity point arrays and a ReasonForTermination cell array. Point vectors are interpolated along the trace. A cell vector array (association CELLS) is traced as constant within each cell, but ParaView's input domain also requires some three-component point array on the input, so a cell-only input fails INPUT_DOMAIN_MISMATCH at update. Convert cell-centred CFD velocity with cellToPoint for the usual smooth traces. The integrator stays at ParaView's Runge-Kutta 4-5 with step lengths in cell lengths. Use pvStreamTracerWithCustomSource to change the integrator, step unit or terminal speed, and pvStreamTracer for ParaView's built-in seed shapes.
  • surface — Extracts the outer boundary surface of any dataset as polygonal data: the exterior faces of volume cells plus any 2-D, line and vertex cells already present. Use it to turn a volume mesh into a surface for rendering, normals, featureEdges, decimate or surface export, or to see the whole boundary of a CFD domain (walls, inlets and outlets together). Cell arrays are copied from the adjacent cell to each face and point arrays are passed; nothing is interpolated.
  • temporalStatistics — Computes, for every point and cell array of a time-dependent input, its average, minimum, maximum and population standard deviation over all input time steps, which the filter requests itself. The output has the input's type and geometry, no time, and arrays named <name>_average, <name>_minimum, <name>_maximum and <name>_stddev (other arrays are not kept). Every step is weighted equally regardless of time spacing, so this is not a time integral. Schemaxis enables all four statistics by default; use pvTemporalStatistics only if you want the generated binding with native option names.
  • threshold — Keeps the cells of a mesh whose selected point or cell scalar lies inside the inclusive range [lower, upper], producing an unstructured grid. Schemaxis fixes ParaView's ThresholdMethod to Between, requires all three options, checks that lower does not exceed upper and that the named array exists with the stated association. Use it to isolate a region such as hot gas or a recirculation zone; use pvThreshold for inverted, one-sided or component-wise tests.
  • transform — Applies a linear transform to the point coordinates: scale, then rotation, then translation, all about the coordinate origin [0, 0, 0]. Vectors and normals are transformed with the geometry (every three-component array while allVectors is true). Polygonal, unstructured and structured grids keep their type; image data and rectilinear grids become an explicit-point dataset. Use it to position, orient or rescale geometry, e.g. scale [0.001, 0.001, 0.001] to convert millimetre coordinates to metres.
  • triangulate — Converts polygonal data so that every polygon and triangle strip becomes triangles and polylines become single line segments; vertices are kept. The output is vtkPolyData on the same points, with cell values copied from each parent cell. Use it before operations or exports that need triangles, such as decimate or STL output. It accepts only polygonal input: run surface first for volume data, or use pvTetrahedralize to split volume cells into tetrahedra.
  • tube — Builds a polygonal tube of constant radius around each line or polyline of polygonal input, typically streamlines from streamTracer, so that thin lines become visible shaded geometry in images and exports. The output is vtkPolyData, and input point arrays are carried onto the tube surface so it can be coloured by the same fields. Schemaxis assigns radius 0.1, 12 sides and capped ends; ParaView's radius variation stays off, so use pvTube for tubes whose radius follows a scalar or vector.
  • warpScalar — Displaces each point along a direction by scale times a point scalar (new position = point + scale x value x direction), turning a field on a flat surface into a relief or carpet plot, or moving a surface by a normal displacement. With useNormal true (Schemaxis default) every point moves along the same normal (default z+); with useNormal false the input's point normals are used when present. The output keeps the input type, except that image data and rectilinear grids become a structured grid; all arrays are carried along.
  • warpVector — Moves every point by scale times a three-component point vector (new position = point + scale x vector), typically to show a structural displacement field or exaggerate a deformation mode. The output keeps the input type (image data and rectilinear grids become structured grids) and carries all arrays. With scale 1 and a displacement in the same length units as the coordinates the result is the true deformed shape; warping by a velocity is only a visual distortion.
  • wavelet — Creates a synthetic uniform image (vtkImageData) whose point array RTData combines a Gaussian peak of height maximum with sinusoidal terms along x, y and z. With the Schemaxis defaults it is a 21 x 21 x 21-point grid with unit spacing spanning -10 to 10 on each axis. Use it as a self-contained input to try slice, contour, clip, streamTracer or scene settings without a real case; its values have no physical meaning or units.

append#

Combines the meshes of several input nodes (any dataset types, non-composite) into one unstructured grid, ParaView 5.13.3's default output type for Append Datasets. Points are not merged and only point and cell arrays present on every input are kept. Use it to treat parts as one dataset for a filter or export; use appendGeometry for surfaces, group to keep inputs as separate blocks, and merge for the blocks of one composite node.

Common mistakes and assumptions:

  • Arrays missing on any input are dropped; make array names consistent across inputs first.
  • Coincident points at part interfaces stay duplicated; follow with cleanGrid to merge them.

Native constructor: AppendDatasets. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "append",
  "inputs": {
    "input": [
      "UPSTREAM_input"
    ]
  }
}

appendGeometry#

Appends several polygonal (vtkPolyData) inputs, such as surfaces, lines or point clouds, into one polydata without merging points. Only point and cell arrays common to all inputs survive. Use it to combine surface parts for a joint export or surface filter; use append for mixed dataset types.

Common mistakes and assumptions:

  • Shared edges between parts keep duplicate points; run clean afterwards for a connected surface (needed for consistent normals or connectivity).

Native constructor: AppendGeometry. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "appendGeometry",
  "inputs": {
    "input": [
      "UPSTREAM_input"
    ]
  }
}

calculator#

Evaluates a ParaView Calculator expression at every point or cell and adds the result as a new array named by result, e.g. velocity magnitude mag(U) or a non-dimensional group. The output is the input dataset type with one more array of the chosen association; existing arrays and geometry are unchanged. Use pvCalculator for coordinate results, other result types or table data.

Common mistakes and assumptions:

  • The expression language is ParaView's parser (ExprTk syntax), not Python and not a Schemaxis $calc expression.
  • An expression can only use arrays of the selected association; point and cell arrays cannot be mixed, and nothing is interpolated between them.
  • Invalid results (e.g. sqrt of a negative) are replaced by 0 under ParaView's defaults, which can hide errors.

Native constructor: Calculator. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset (vtkDataSet, vtkTable or vtkGraph) to the Calculator filter. The scalar and vector variables may be chosen from this dataset's arrays. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); graphs (vertices and edges) (vtkGraph); tables (rows and columns) (vtkTable); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkGraph","vtkTable","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
expression The equation evaluated on the selected point or cell arrays. Use native array names and vector components. For a vector U, sqrt(U_XU_X+U_YU_Y+U_Z*U_Z) computes its magnitude. {"type":"string","minLength":1} required "REPLACE_WITH_VALUE"
result Name assigned to the calculated array. Use this exact name for downstream colouring, contours or further calculations; it is not a numeric data type. {"type":"string","minLength":1} required "REPLACE_WITH_VALUE"
association Choose where the input arrays live. Cell Data computes one result per cell; Point Data computes one per mesh point. This choice does not interpolate between them. {"type":"enum","values":["Point Data","Cell Data"]} "Point Data" "Point Data"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "calculator",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "expression": "REPLACE_WITH_VALUE",
    "result": "REPLACE_WITH_VALUE"
  }
}

cellSize#

Adds cell-data arrays holding the size of each cell: Length for 1-D cells (lines, polylines), Area for 2-D cells (triangles, quads, polygons) and Volume for 3-D cells, all in dataset coordinate units (length, length squared, length cubed). Cells of a dimension that is not computed get 0 in that array. Use it for cell volumes or face areas, e.g. to weight cell values or check mesh resolution; with sum enabled the totals are also stored as field data. pvCellSize exposes the same filter with every native setting, including the vertex count and array names; pvMeshQuality rates cell shape instead of size.

Common mistakes and assumptions:

  • Each array is filled for every cell, so a mixed mesh shows 0 in Volume for its faces and 0 in Area for its volume cells; filter by cell type before taking statistics.
  • Polygon areas are computed by a fan triangulation that is exact only for convex planar polygons.

Native constructor: CellSize. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Size filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
area Specify whether or not to compute the area of 2D cells. {"type":"boolean"} true true
volume Specify whether or not to compute the volume of 3D cells . {"type":"boolean"} true true
length Specify whether or not to compute the length of 1D cells. {"type":"boolean"} true true
sum Specify whether or not to sum the computed sizes of cells in datasets. The result is stored in field data. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "cellSize",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

cellToPoint#

Interpolates cell-centred arrays to mesh points: each point receives the average of the cells that use it, producing point fields for stream tracing, contours and smooth colouring. The mesh is unchanged. Averaging smooths sharp cell-to-cell changes and blurs discontinuities such as shocks or material interfaces. Use pointToCell for the reverse.

Common mistakes and assumptions:

  • Averages are unweighted across neighbouring cells, so values at boundaries between very different cells are not conservative.
  • With passCellData true (Schemaxis default) the output carries both versions of each array; select the association explicitly downstream.

Native constructor: CellDatatoPointData. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
passCellData Retain the original cell arrays alongside the new point arrays. {"type":"boolean"} true true
allArrays Process all available input arrays. Disable this and specify arrays to restrict the conversion. {"type":"boolean"} true true
arrays Names of arrays to convert when allArrays is false. They must exist on the input association. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Conditional requirements:

[
  {
    "when": [
      "allArrays",
      false
    ],
    "option": "arrays"
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "cellToPoint",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

clean#

Cleans polygonal data: merges duplicate points within a tolerance, removes unused points and turns degenerate cells into lower-dimensional ones (a triangle with two merged points becomes a line). Output is polydata. Use it after appendGeometry or on surfaces with duplicated vertices to get a connected surface for normals, curvature, connectivity or decimation. For other dataset types use cleanGrid.

Common mistakes and assumptions:

  • A large tolerance collapses small features and can change topology; keep it well below the smallest edge length.

Native constructor: Clean. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
mergePoints If this property is set to 1, then points will be merged if they are within the specified Tolerance or AbsoluteTolerance (see the Tolerance and AbsoluteTolerance properties), depending on the value of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute property.) If this property is set to 0, points will not be merged. {"type":"boolean"} true true
tolerance If merging nearby points (see PointMerging property) and not using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging as a fraction of the length of the diagonal of the bounding box of the input data set. {"type":"number","minimum":0} 0 0
absolute This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging. {"type":"boolean"} false false
absoluteTolerance If merging nearby points (see PointMerging property) and using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging in the spatial units of the input data set. {"type":"number","minimum":0} 0 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "clean",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

cleanGrid#

Converts any dataset into an unstructured grid and merges coincident points (exactly coincident at the Schemaxis default tolerance 0), optionally removing points used by no cell (Schemaxis default true). Use it to obtain an unstructured grid for operations that need one, or to stitch appended parts. Use clean when the input is polydata and polydata output is wanted.

Common mistakes and assumptions:

  • Structured inputs lose their implicit structure and grow in memory once converted.

Native constructor: CleantoGrid. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
tolerance When merging nearby points and not using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging as a fraction of the length of the diagonal of the bounding box of the input data set. {"type":"number","minimum":0} 0 0
removeUnusedPoints Drop points that no cell references, such as orphan nodes left by extraction. Disable it when isolated points carry meaning: a point cloud without vertex cells would otherwise lose every point. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "cleanGrid",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

clip#

Cuts the input with a plane through origin with normal normal and keeps one side, returning an unstructured grid of whole and cut cells (dimension is kept, unlike slice). With the Schemaxis default invert false the kept half is the side the normal points into; true keeps the opposite side. Use it to open a volume for viewing interior fields; use pvClip for box, sphere, cylinder or scalar clips and for crinkle (whole-cell) clipping.

Common mistakes and assumptions:

  • ParaView's own Clip starts with Invert on (keeping the side opposite the normal); Schemaxis sets invert false by default, so results can be mirrored relative to a ParaView GUI session.
  • Clipping structured data produces an unstructured grid, which can use much more memory.

Native constructor: Clip. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset on which the Clip filter will operate. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
origin A point lying on the cutting plane, expressed as [X, Y, Z] in dataset coordinates. Moving it along the normal moves the cut. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
normal Direction perpendicular to the plane. Use z+ for an XY plane, y+ for XZ, and x+ for YZ; a nonzero XYZ vector or declared direction object also works. {"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}]} [1,0,0] [1,0,0]
invert Reverse which side of the plane is retained. Check the result against the plane normal in a preview. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "clip",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

cone#

Creates a polygonal cone surface of given height and base radius. Its centre is the midpoint of the axis, the axis follows direction, and the apex lies on the direction side; resolution sets the number of facets around the axis and capping closes the base. Use it as a marker, glyph or simple test geometry; coordinates are in the units of the data it is shown with.

Common mistakes and assumptions:

  • centre is not the centre of the base: the base lies height/2 behind it and the apex height/2 ahead along direction.

Native constructor: Cone. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
centre This property specifies the center of the cone. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
direction An axis token, a vector, or an azimuth and elevation about an up axis {"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}]} [1,0,0] [1,0,0]
height This property specifies the height of the cone. {"type":"number","minimum":0,"exclusiveMinimum":true} 2 2
radius This property specifies the radius of the base of the cone. {"type":"number","minimum":0,"exclusiveMinimum":true} 1 1
resolution This property indicates the number of divisions around the cone. The higher this number, the closer the polygonal approximation will come to representing a cone, and the more polygons it will contain. Schemaxis accepts at most 512 facets: the bundled VTK clamps larger values to 512 (VTK_CELL_SIZE) without a warning, so a larger request would not be honoured. {"type":"integer","minimum":3,"maximum":512} 32 32
capping If this property is set to 1, the base of the cone will be capped with a filled polygon. Otherwise, the base of the cone will be open. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "cone"
}

connectivity#

Labels the connected regions of the input (cells linked through shared points) and keeps all regions, the largest one (most cells) or the one closest to a point; output is an unstructured grid. With colourRegions (Schemaxis default true) a RegionId array identifies each region. Use it to separate disjoint bodies, drop small fragments or isolate the part near a location.

Common mistakes and assumptions:

  • Connectivity is topological: parts that touch only geometrically, with duplicate points, count as separate regions; run clean or cleanGrid first.

Native constructor: Connectivity. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
mode Controls the extraction of connected surfaces. {"type":"enum","values":["Extract All Regions","Extract Largest Region","Extract Closest Point Region"]} "Extract All Regions" "Extract All Regions"
colourRegions Controls the coloring of the connected regions. {"type":"boolean"} true true
closestPoint Specifies the point to use in closest point mode. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "connectivity",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

contour#

Extracts isosurfaces (3-D input) or isolines (2-D input) where a point-centred scalar field equals each of the given values, and outputs them as polydata; several values give several surfaces in one output. Use it for level sets such as a temperature front or a Q-criterion vortex surface. By Schemaxis default the output carries normals and the contour value as an array, but no gradients. Use pvContour for the full native settings.

Common mistakes and assumptions:

  • The scalar must be point data; for cell arrays run cellToPoint first.
  • Values outside the field's range produce an empty output without an error.

Native constructor: Contour. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to be used by the contour filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point-centred array with 1 component (for vtkDataSet input). The input needs at least one cell-centred array with 1 component (for vtkHyperTreeGrid input). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
field Select the association and scalar array whose level surfaces will be extracted. Point scalars are the usual input; convert cell arrays when required. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
values One or more scalar levels to extract. Choose values within the actual input range and in that field’s units. {"type":"array","items":{"type":"number"},"minItems":1} required [1]
normals If this property is set to 1, a scalar array containing a normal value at each point in the isosurface or isoline will be created by the contour filter; otherwise an array of normals will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0. Select whether to compute normals. {"type":"boolean"} true true
gradients If this property is set to 1, a scalar array containing a gradient value at each point in the isosurface or isoline will be created by this filter; otherwise an array of gradients will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0. Not that if ComputeNormals is set to 1, then gradients will have to be calculated, but they will only be stored in the output dataset if ComputeGradients is also set to 1. {"type":"boolean"} false false
scalars If this property is set to 1, an array of scalars (containing the contour value) will be added to the output dataset. If set to 0, the output will not contain this array. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "contour",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "field": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ],
    "values": [
      1
    ]
  }
}

curvature#

Computes per-point curvature of a polygonal surface (Gaussian or mean, the two curvature types ParaView 5.13.3 offers) as a point array such as Mean_Curvature or Gauss_Curvature. Use it to locate ridges, valleys or highly curved regions on CAD or scanned surfaces. Mean curvature is in inverse length units and Gaussian in inverse length squared; both are noisy on coarse or irregular triangulations. The mean-curvature sign assumes outward normals.

Common mistakes and assumptions:

  • type accepts only Gaussian or Mean, the entries of ParaView 5.13.3's Curvature enumeration (filters_filtersgeneral.xml:445-485); maximum and minimum principal curvature are not available and any other value is rejected at planning.
  • If convex regions show negative mean curvature, the normals point inward; set invertMean.

Native constructor: Curvature. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
type This property specifies which type of curvature to compute. {"type":"enum","values":["Gaussian","Mean"]} "Mean" "Mean"
invertMean If this property is set to 1, the mean curvature calculation will be inverted. This is useful for meshes with inward-pointing normals. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "curvature",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

cylinder#

Creates a polygonal cylinder surface of given radius and height, centred on centre with its axis parallel to y, including point normals and texture coordinates. resolution sets the facets around the axis and capping closes both ends. There is no orientation setting: follow it with transform to rotate the cylinder.

Common mistakes and assumptions:

  • The axis is always along y before any transform; a cylinder meant along z needs a 90-degree rotation about x.

Native constructor: Cylinder. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
centre This property specifies the coordinate value at the center of the cylinder. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
height This property specifies the height of the cylinder (along the y axis). {"type":"number","minimum":0,"exclusiveMinimum":true} 2 2
radius This property specifies the radius of the cylinder. {"type":"number","minimum":0,"exclusiveMinimum":true} 1 1
resolution This property indicates the number of divisions around the cylinder. The higher this number, the closer the polygonal approximation will come to representing a cylinder, and the more polygons it will contain. Schemaxis accepts at most 512 facets: the bundled VTK clamps larger values to 512 (VTK_CELL_SIZE) without a warning, so a larger request would not be honoured. {"type":"integer","minimum":3,"maximum":512} 32 32
capping If this property is set to 1, the ends of the cylinder will each be capped with a closed polygon. Otherwise, the ends of the cylinder will be open. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "cylinder"
}

decimate#

Reduces the triangle count of a polygonal surface by a target fraction (Schemaxis default 0.5) with vtkDecimatePro, trying to preserve shape; preserveTopology (Schemaxis default true) prevents holes and splits at the cost of possibly missing the target. Use it to lighten large surfaces for rendering or export. Input must be triangles; run triangulate first if other polygons are present.

Common mistakes and assumptions:

  • Small features and sharp detail are lost first; compare with the original before measuring on the result.

Native constructor: Decimate. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
reduction This property specifies the desired reduction in the total number of polygons in the output dataset. For example, if the TargetReduction value is 0.9, the Decimate filter will attempt to produce an output dataset that is 10% the size of the input.) {"type":"number","minimum":0,"maximum":1} 0.5 0.5
preserveTopology If this property is set to 1, decimation will not split the dataset or produce holes, but it may keep the filter from reaching the reduction target. If it is set to 0, better reduction can occur (reaching the reduction target), but holes in the model may be produced. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "decimate",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

delaunay2D#

Builds a 2-D Delaunay triangulation of the input points (any point set, e.g. a point cloud or the points of a mesh; input cells are ignored) and outputs polydata triangles. Triangulation is done in the x-y plane: z is ignored for connectivity but kept on the points, so it suits height fields and nearly planar sets aligned with x-y. With alpha 0 (Schemaxis default) every triangle of the convex hull is kept; a positive alpha keeps only triangles whose circumcircle radius is at most alpha, carving concave outlines and gaps. Use pvDelaunay2D for a best-fitting plane, and delaunay3D for tetrahedra.

Common mistakes and assumptions:

  • Points on a plane not parallel to x-y (e.g. a vertical wall) triangulate badly or collapse; transform them first or use pvDelaunay2D with ProjectionPlaneMode Best-Fitting Plane.
  • Points closer than tolerance (a fraction of the bounding-box diagonal) are discarded as duplicates.

Native constructor: Delaunay2D. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the Delaunay 2D filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
alpha The value of this property controls the output of this filter. For a non-zero alpha value, only edges or triangles contained within a sphere centered at mesh vertices will be output. Otherwise, only triangles will be output. {"type":"number","minimum":0} 0 0
tolerance This property specifies a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points. {"type":"number","minimum":0} 1e-05 1e-05

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "delaunay2D",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

delaunay3D#

Builds a 3-D Delaunay tetrahedralization of the input points (any point set) and outputs an unstructured grid of tetrahedra filling their convex hull. A positive alpha (Schemaxis default 0) produces an alpha shape: only tetrahedra whose circumsphere radius is at most alpha, plus qualifying triangles, are kept, which recovers concave shapes from point clouds. Use it to mesh scattered 3-D samples for interpolation or volume estimates; use delaunay2D for surface-like sets and pvDelaunay3D to choose which alpha cell types are output.

Common mistakes and assumptions:

  • Output grows quickly and ParaView warns that Delaunay 3D can exhaust memory; thin large point sets first.
  • Points on a regular lattice are degenerate: the result depends on point order, and nearly coplanar points produce sliver tetrahedra.

Native constructor: Delaunay3D. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the Delaunay 3D filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
alpha This property specifies the alpha (or distance) value to control the output of this filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be output. Otherwise, only tetrahedra will be output. {"type":"number","minimum":0} 0 0
tolerance This property specifies a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points. {"type":"number","minimum":0} 0.001 0.001

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "delaunay3D",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

disk#

Creates a flat annulus (polydata) centred at the origin in the XY plane, with inner and outer radius and radial and circumferential resolution; set innerRadius to 0 for a full disc. Use it as a seed or probe surface, a marker or test geometry, and place it with transform.

Common mistakes and assumptions:

  • Schemaxis requires innerRadius not to exceed outerRadius.

Native constructor: Disk. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
innerRadius Specify inner radius of hole in disc. {"type":"number","minimum":0} 0.25 0.25
outerRadius Specify outer radius of disc. {"type":"number","minimum":0,"exclusiveMinimum":true} 1 1
radialResolution Set the number of points in radial direction. {"type":"integer","minimum":1,"maximum":4096} 2 2
resolution Set the number of points in circumferential direction. {"type":"integer","minimum":3,"maximum":4096} 32 32

Cross-option checks:

[
  {
    "kind": "ordered",
    "options": [
      "innerRadius",
      "outerRadius"
    ]
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "disk"
}

edges#

Extracts every edge of every cell as a line cell, giving a wireframe polydata of the whole mesh, including interior edges of volume cells. Each shared edge appears once and receives the cell data of the lowest-numbered cell using it. Use it to show or export mesh structure or to measure edge lengths; use featureEdges for only boundary or sharp edges of a surface, and run surface first if only the outer skin's edges are wanted.

Common mistakes and assumptions:

  • On volume meshes the output holds all interior edges and can be several times larger than the input; ParaView warns about memory for structured inputs.

Native constructor: ExtractEdges. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Edges filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "edges",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

elevation#

Adds a point scalar array named Elevation: each point is projected onto the line from lowPoint to highPoint and the position along that line is mapped linearly onto range, clamped at both ends. Use it to colour by height or depth along any direction, or as a synthetic field for testing. Schemaxis assigns its defaults (z from -1 to 1 mapped to 0 to 1), so set the points to your data's extent.

Common mistakes and assumptions:

  • Points beyond either end point all receive the end value, so a line shorter than the data flattens the field outside it.

Native constructor: Elevation. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
lowPoint This property defines low end of the direction vector (small scalar values). {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,-1] [0,0,-1]
highPoint This property defines the high end of the direction vector (large scalar values). {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,1] [0,0,1]
range This property determines the range into which scalars will be mapped. {"type":"array","items":{"type":"number"},"minItems":2,"maxItems":2} [0,1] [0,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "elevation",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

extractBlock#

Extracts selected blocks from a composite dataset (multiblock, partitioned dataset collection or AMR), such as the internalMesh or individual patches of an OpenFOAM case read by foam. Blocks are chosen by selectors, path expressions over the input's block hierarchy such as "/Root/internalMesh" or "//inlet". The output keeps the composite type with only the selected blocks (overlapping AMR becomes a partitioned dataset collection). Use merge afterwards when one dataset is needed; pvExtractBlock also exposes the assembly choice.

Common mistakes and assumptions:

  • Selectors that match nothing give an empty composite rather than an error; check names in the input hierarchy (Studio lists them).
  • Only blocks that the reader loaded can be extracted; enable the patches in the reader options first.

Native constructor: ExtractBlock. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input to this filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet); AMR data (vtkUniformGridAMR); partitioned dataset collections (vtkPartitionedDataSetCollection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet","vtkUniformGridAMR","vtkPartitionedDataSetCollection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
selectors Choose named parts of the input dataset, such as internalMesh or individual wall patches. Studio reads the input hierarchy and writes the native selector paths for you. Only blocks loaded by the reader can be selected. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "extractBlock",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "selectors": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

extractSubset#

Extracts a volume of interest from structured data (image data, rectilinear or structured grid) by an IJK point-index range, optionally keeping every n-th index. The output keeps the input's structured type, so it stays compact and works with structured filters. Use it to crop a structured block or image by index; use a clip for geometric cuts or unstructured meshes.

Common mistakes and assumptions:

  • Indices are in the input's extent space, which need not start at 0; inspect the input extent before choosing the range.

Native constructor: ExtractSubset. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid); structured points (image data) (vtkStructuredPoints); curvilinear structured grids (vtkStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkRectilinearGrid","vtkStructuredPoints","vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
extent This property specifies the minimum and maximum point indices along each of the I, J, and K axes; these values indicate the volume of interest (VOI). The output will have the (I,J,K) extent specified here. {"type":"array","items":{"type":"integer"},"minItems":6,"maxItems":6} required [1,1,1,1,1,1]
rateI This property indicates the sampling rate in the I dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"type":"integer","minimum":1} 1 1
rateJ This property indicates the sampling rate in the J dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"type":"integer","minimum":1} 1 1
rateK This property indicates the sampling rate in the K dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"type":"integer","minimum":1} 1 1
includeBoundary If the value of this property is 1, then if the sample rate in any dimension is greater than 1, the boundary indices of the input dataset will be passed to the output even if the boundary extent is not an even multiple of the sample rate in a given dimension. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "extractSubset",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "extent": [
      1,
      1,
      1,
      1,
      1,
      1
    ]
  }
}

featureEdges#

Extracts edges of a polygonal surface as line cells (polydata): boundary edges (used by one polygon), feature edges (between two polygons whose normals differ by more than angle), non-manifold edges (shared by three or more polygons) and optionally manifold edges. With the Schemaxis defaults (boundary, feature and non-manifold on, manifold off, 30°) it outlines a CAD or CFD surface's creases, open boundaries and T-junctions. Input must be polydata; run surface first on volume meshes. Use edges for every cell edge.

Common mistakes and assumptions:

  • Feature detection uses polygon normals, so inconsistently oriented polygons create spurious feature edges; run normals with consistency first.
  • Unmerged duplicate points make every polygon edge a boundary edge; run clean first.

Native constructor: FeatureEdges. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Feature Edges filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
boundary If the value of this property is set to 1, boundary edges will be extracted. Boundary edges are defined as lines cells or edges that are used by only one polygon. {"type":"boolean"} true true
feature If the value of this property is set to 1, feature edges will be extracted. Feature edges are defined as edges that are used by two polygons whose dihedral angle is greater than the feature angle. (See the FeatureAngle property.) Toggle whether to extract feature edges. {"type":"boolean"} true true
manifold If the value of this property is set to 1, manifold edges will be extracted. Manifold edges are defined as edges that are used by exactly two polygons. {"type":"boolean"} false false
nonManifold If the value of this property is set to 1, non-manifold edges will be extracted. Non-manifold edges are defined as edges that are use by three or more polygons. {"type":"boolean"} true true
angle The value of this property is used to define a feature edge. If the surface normal between two adjacent triangles is at least as large as this Feature Angle, a feature edge exists. (See the FeatureEdges property.) {"type":"number","minimum":0,"maximum":180} 30 30

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "featureEdges",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

foam#

Curated OpenFOAM reader: opens a case through its .foam marker file and outputs a multiblock dataset whose blocks are the selected mesh regions (internalMesh volume cells, patch/<name> boundaries) carrying the selected cell fields, with one time step per stored time directory. Schemaxis defaults read a decomposed case (processor* folders), only internalMesh, and keep the 0 directory; other reader settings keep ParaView's defaults, which also create point data interpolated from the cell fields. Use pvOpenFOAMReader for point or Lagrangian fields, zones, label/scalar size or the other native options.

Common mistakes and assumptions:

  • caseType defaults to Decomposed Case in Schemaxis (ParaView's own default is Reconstructed Case); for a serial or reconstructed case set Reconstructed Case, otherwise the reader finds no data.
  • Boundary patches are loaded only when listed in regions as patch/<name>.
  • Pick stored times with the document's times selection using this node as the source.

Native constructor: OpenFOAMReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
file Choose the path and filename of a .foam marker in your OpenFOAM case folder, for example /data/coupe/coupe.foam. The marker can be empty: its parent folder contains the actual mesh and time directories. Absolute paths are accepted. Relative paths are resolved from the directory where Studio was launched, not from the JSON file folder. Browse inserts an absolute path; the dataset stays in place and is not uploaded or copied. Fixed at construction; cannot vary per visit. {"type":"string","minLength":1} required "REPLACE_WITH_VALUE"
caseType Choose Decomposed Case when the results remain in processor0, processor1 and other processor folders. Choose Reconstructed Case for a serial case or results reconstructed into the main case folder. Match the layout of the data you want to read. Fixed at construction; cannot vary per visit. {"type":"enum","values":["Decomposed Case","Reconstructed Case"]} "Decomposed Case" "Decomposed Case"
regions Mesh regions to load. internalMesh is the volume mesh; add boundary patches with the reader's prefixed names, e.g. "patch/inlet" or "patch/walls", when you also want those surfaces. Names must match regions available in your case. Omitting this setting loads internalMesh. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} ["internalMesh"] ["internalMesh"]
cellArrays Names of cell fields to read, for example U for velocity, p for pressure, or nut for turbulent viscosity. Names depend on your case. This selects existing fields; it does not calculate new ones. If omitted, Schemaxis leaves the reader’s field selection at its native default. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} native initialisation / omitted ["REPLACE_WITH_VALUE"]
skipZero Enable this to skip the initial time directory 0 when reading available times. Leave it disabled when you want to inspect the initial conditions as well as later results. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "foam",
  "options": {
    "file": "REPLACE_WITH_VALUE"
  }
}

generateIds#

Adds arrays holding each point's and each cell's index (zero-based ids in the input), so that later clipping, extraction or merging carries the original ids along and results can be traced back to the source mesh. The geometry and type are unchanged and existing arrays are kept; each generated id array becomes that attribute's active scalars. For hyper-tree grids cell ids are always generated, and pointIds, pointName and cellIds have no effect.

Common mistakes and assumptions:

  • Ids are indices in this node's input, not solver-native ids; apply the operation before filters that renumber points or cells.

Native constructor: PointAndCellIds. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
pointIds Enable generation of point ids. {"type":"boolean"} true true
cellIds Enable generation of cell ids. {"type":"boolean"} true true
pointName The name of the point ids array. {"type":"string","minLength":1} "pointIds" "pointIds"
cellName The name of the cell ids array. {"type":"string","minLength":1} "cellIds" "cellIds"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "generateIds",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

gradient#

Estimates the spatial gradient of a point or cell array and stores it as a new array on the same mesh: 3 components for a scalar, 9 (row-major d(component)/d(x, y, z)) for a 3-component vector. Optionally adds divergence, vorticity and the Q-criterion of a vector field, e.g. for vortex identification. Unstructured meshes use cell derivatives, structured ones central differences. Use pvGradient for the full native settings and other output names.

Common mistakes and assumptions:

  • Divergence, vorticity and Q-criterion need a 3-component array; they fail or are skipped for scalars.
  • Derivatives are in field units per dataset length unit; no unit conversion is applied.

Native constructor: Gradient. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input to the Gradient filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
field Specify the name of the scalar array from which to compute the gradient. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
result Provide a name for the output array containing the gradient vectors. {"type":"string"} "gradient" "gradient"
gradient If on, the gradient of the input array is computed. {"type":"boolean"} true true
divergence If on, the divergence of a 3-component array is computed. {"type":"boolean"} false false
vorticity If on, the vorticity/curl of a 3-component array is computed. {"type":"boolean"} false false
qCriterion If on, the Q-criterion of a 3-component array is computed. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "gradient",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "field": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ]
  }
}

group#

Combines several input nodes into one multiblock (composite) dataset, one block per input in connection order, without changing the data. Use it to process, colour or export several parts together while keeping them distinct; use append or merge when you need a single mesh.

Common mistakes and assumptions:

  • Filters that need a non-composite input will not accept the grouped result; merge it first.

Native constructor: GroupDatasets. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any data object (vtkDataObject); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
names Specify names to use for each input. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "group",
  "inputs": {
    "input": [
      "UPSTREAM_input"
    ]
  }
}

integrate#

Integrates all point and cell arrays over the input's cells and computes the total length, area or volume, producing a one-point unstructured grid with one integrated value per array. Only cells of the highest dimension present are used (a volume mesh ignores its faces) and vertex cells are not integrated. With divideByVolume the cell-data integrals are divided by the total size, giving size-weighted means. Use it for totals such as mass or force and for mean values; results carry the array units times length, area or volume.

Common mistakes and assumptions:

  • Point-data results are never divided; for a point-field mean divide by the size array yourself or convert to cell data first.
  • Integrating a vector gives componentwise integrals, not a flux; compute the normal component with a calculator first.

Native constructor: IntegrateVariables. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
divideByVolume Divide integrated cell-data values by the dataset measure (length, area or volume for the retained cell dimension), producing a mean rather than a total. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "integrate",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

line#

Creates a straight polyline from start to end with resolution intervals (Schemaxis default 20, so 21 points), as a separate polydata source. Connect it to streamTracer.seed to place streamline seeds, or use it as probe geometry; it is not the velocity dataset and carries no fields. To sample fields along a segment use probeLine.

Common mistakes and assumptions:

  • Coordinates use the dataset coordinate system. A line inside the bounding box can still cross solid regions or gaps.
  • Resolution is the number of intervals, so a line with resolution 20 has 21 points.

Native constructor: Line. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
start First endpoint as [X, Y, Z], in the same world-coordinate system as the dataset. Use preview bounds to locate it. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [-1,0,0] [-1,0,0]
end Second endpoint as [X, Y, Z]. Choose a different point from the start to define a nonzero line. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [1,0,0] [1,0,0]
resolution Number of intervals along the line; N intervals give N+1 points. {"type":"integer","minimum":1} 20 20

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "line"
}

merge#

Merges every leaf dataset of a composite input (multiblock or partitioned data, e.g. the regions and patches from foam) into one unstructured grid, ParaView's default output type. Use it before operations or exports that need a single non-composite dataset. Point merging (on by Schemaxis default) fuses exactly coincident points at block interfaces so the result is connected. Use pvMergeBlocks for polydata output, a merge tolerance or partition-only merging, and append to combine separate nodes.

Common mistakes and assumptions:

  • Block identity and names are lost; use extractBlock first if only some blocks should be merged.
  • Arrays that are missing on some blocks may be absent or incomplete after merging; check the output arrays.

Native constructor: MergeBlocks. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input composite dataset. Accepted data: data-object trees (multiblock or partitioned) (vtkDataObjectTree). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObjectTree"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
mergePoints Merge points within a distance specified by the Tolerance property. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "merge",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

normals#

Computes point normals of a polygonal surface by averaging the normals of adjacent polygons, for smooth shading and for operations that need normals (warping along normals, glyphs). With splitting, points on edges sharper than featureAngle are duplicated so each side keeps its own normal; consistency reorders polygons so neighbours agree. Output is polydata with a Normals point array.

Common mistakes and assumptions:

  • Consistent orientation does not make normals point outward; check their direction, since flipping is not exposed by this operation.
  • Schemaxis turns splitting off by default (ParaView's own default is on), so sharp edges are shaded smoothly unless you enable it.
  • Input must be polygonal; extract the surface of a volume mesh first (surface).

Native constructor: SurfaceNormals. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
consistency Try to orient neighbouring polygon normals consistently. This does not establish which side is physically outward. {"type":"boolean"} true true
splitting Duplicate points at sharp edges to allow different normals on each side. {"type":"boolean"} false false
featureAngle Angle used to classify sharp edges for normal splitting. {"type":"number","minimum":0,"maximum":180} 30 30

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "normals",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

outline#

Produces the 12 edges of the input's axis-aligned bounding box as polydata lines. Use it as a context frame in scenes or to check a dataset's extent; it carries no field data.

Common mistakes and assumptions:

  • The box is axis-aligned, so it can be much larger than a rotated or thin object.

Native constructor: Outline. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); graphs (vertices and edges) (vtkGraph). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "outline",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

passArrays#

Keeps only the named point, cell and field arrays of the input and removes every other array of those associations; geometry and topology are unchanged (shallow copy, so it is cheap). Use it to slim a dataset before export or publication, or to drop arrays that would confuse later steps. Each list has the Schemaxis default [], and an empty list keeps none of that association's arrays. Use pvPassArrays when vertex, edge or row (table) arrays also need selecting.

Common mistakes and assumptions:

  • Listing only pointArrays removes every cell and field array, because the other lists default to []; list the arrays you need in each association.
  • Names are matched exactly; a misspelt name keeps nothing and the array disappears.
  • Ghost-cell arrays (vtkGhostType) are kept unless explicitly deselected.

Native constructor: PassArrays. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
pointArrays Select the point data arrays to pass through. {"type":"array","items":{"type":"string","minLength":1}} [] []
cellArrays Select the cell data arrays to pass through. {"type":"array","items":{"type":"string","minLength":1}} [] []
fieldArrays Select the field data arrays to pass through. {"type":"array","items":{"type":"string","minLength":1}} [] []

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "passArrays",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

plane#

Creates a flat parallelogram (polydata) with one corner at origin and edges running to point1 and point2, subdivided into xResolution × yResolution quadrilaterals. Use it as a probe or seed surface, for example for resampling or streamline seeds, or as test geometry. The Schemaxis defaults give a 2 × 2 square in the XY plane centred at the origin, with 10 × 10 cells.

Common mistakes and assumptions:

  • point1 and point2 must not be collinear with origin, or the plane is degenerate.

Native constructor: Plane. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
origin This property specifies the 3D coordinate of the origin (one corner) of the plane. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [-1,-1,0] [-1,-1,0]
point1 This property specifies the 3D coordinate a second corner of the parallelogram. The line connecting this point and that specified by the Origin property define one edge of the parallelogram (its X axis). {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [1,-1,0] [1,-1,0]
point2 This property specifies the 3D coordinate a third corner of the parallelogram. The line connecting this point and that specified by the Origin property define a second edge of the parallelogram (its Y axis). {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [-1,1,0] [-1,1,0]
xResolution This property specifies the number of divisions along the X axis of the parallelogram. {"type":"integer","minimum":1,"maximum":4096} 10 10
yResolution This property specifies the number of divisions along the Y axis of the parallelogram. {"type":"integer","minimum":1,"maximum":4096} 10 10

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "plane"
}

pointToCell#

Averages point arrays onto cells: each cell receives the unweighted mean of its points' values. The mesh is unchanged; only the array association changes. Use it when a later operation, a threshold or an integration needs cell data, or to compare with cell-centred solver output. Use cellToPoint for the reverse.

Common mistakes and assumptions:

  • Averaging over cell points smooths peaks; the cell values are not exact cell integrals.
  • With passPointData true (Schemaxis default) both versions of each array remain; select the association explicitly downstream.

Native constructor: PointDatatoCellData. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
passPointData Retain the original point arrays alongside the new cell arrays. {"type":"boolean"} true true
allArrays Process all available input arrays. Disable this and specify arrays to restrict the conversion. {"type":"boolean"} true true
arrays Names of arrays to convert when allArrays is false. They must exist on the input association. {"type":"array","items":{"type":"string","minLength":1},"minItems":1} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Conditional requirements:

[
  {
    "when": [
      "allArrays",
      false
    ],
    "option": "arrays"
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pointToCell",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

probeLine#

Samples the input's point and cell arrays along the segment from start to end (Plot Over Line), interpolating within cells, and outputs a polyline with the sampled arrays plus arc_length and vtkValidPointMask (1 where a sample lies inside the data). Use it for spatial profiles, e.g. velocity across a channel. ParaView's XML default sampling pattern is uniform, for which resolution (Schemaxis default 100) is the number of intervals.

Common mistakes and assumptions:

  • Samples outside the mesh have vtkValidPointMask 0 and placeholder values; mask them before plotting or measuring.
  • Sampling behaviour follows the native PlotOverLine settings; resolution controls the uniform-sampling mode.

Native constructor: PlotOverLine. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
start First endpoint as [X, Y, Z], in the same world-coordinate system as the dataset. Use preview bounds to locate it. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [-1,0,0] [-1,0,0]
end Second endpoint as [X, Y, Z]. Choose a different point from the start to define a nonzero line. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [1,0,0] [1,0,0]
resolution Number of intervals when PlotOverLine uses uniform sampling. Native sampling-pattern settings determine how samples are actually placed. {"type":"integer","minimum":1} 100 100

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "probeLine",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

pvADIOS2CoreImageReader#

Reads variables from an ADIOS2 BP file or BP4/BP5 directory as arrays on a uniform image (vtkImageData). One variable (Image Dimension) defines the image size; each selected variable becomes a point or cell array according to its shape, and an optional variable supplies the time values. Use it for simulation codes that write plain multi-dimensional arrays through ADIOS2; use pvADIOS2VTXReader when the file embeds a VTK schema and pvFidesReader when it follows a Fides data model.

Common mistakes and assumptions:

  • Arrays whose shape matches neither the point nor the cell dimensions of the chosen dimension variable cannot be placed on the image; pick the dimension variable that matches the fields you need.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: ADIOS2CoreImageReader. Identity: sources/ADIOS2CoreImageReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Arrays This property lists all adios2 arrays that can be read. Based on the dimension info, arrays will be parsed as point or cell data. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the ADIOS2 filename. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ImageDimension Use the dimension info of the array to populate image dimension. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Timesteparray Use the array to populate time steps info. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Usedimensionarrayascelldata The dimension of image data is 1 larger than its cell data's dimension. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvADIOS2CoreImageReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvADIOS2VTXReader#

Reads an ADIOS2 BP file or BP4 directory that embeds a VTK XML schema (VTX), either as a BP attribute or as a vtk.xml subfile, describing image data (vti) or unstructured grid (vtu) content; the output is that dataset, with time steps from the BP steps. It is a distributed reader. Choose it for codes that write VTX-annotated ADIOS2 output (e.g. via the VTX schema), and pvADIOS2CoreImageReader or pvFidesReader for other ADIOS2 layouts.

Common mistakes and assumptions:

  • Files without the embedded VTK schema cannot be interpreted by this reader.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: ADIOS2VTXReader. Identity: sources/ADIOS2VTXReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property sets the file or directory name. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvADIOS2VTXReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvAMRConnectivity#

Fragment identification on non-overlapping AMR material data (such as CTH output from pvSpyPlotReader): for each selected volume-fraction cell array it labels connected regions of cells whose value exceeds VolumeFractionValue, including across block and level boundaries when ResolveBlocks is on, and adds a cell array RegionId-<array name>. The output is the same AMR data with these labels; pvAMRFragmentIntegration then sums fragment volumes and masses. Use pvAMRFragmentsFilter to run the whole chain in one step.

Common mistakes and assumptions:

  • Unlike AMR Contour and AMR Dual Clip, this filter compares VolumeFractionValue with the stored array values without scaling by 255; with unsigned char fractions the default 0.1 therefore keeps any cell with a non-zero fraction.
  • Without at least one SelectMaterialArrays entry no labels are produced.
  • Overlapping AMR is rejected; the input must be vtkNonOverlappingAMR.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMRConnectivity. Identity: filters/AMRConnectivity. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the volume input of the filter. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
PropagateGhosts Propagate regionIds into the ghosts. {"type":"boolean"} native initialisation / omitted false
ResolveBlocks Resolve the fragments between blocks. {"type":"boolean"} native initialisation / omitted false
SelectMaterialArrays This property specifies the cell arrays from which the analysis will determine fragments {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VolumeFractionValue This property specifies the values at which to compute the isosurface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRConnectivity",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAMRContour#

AMR Contour (vtkPVAMRDualContour) extracts material interface surfaces from non-overlapping AMR volume-fraction data using the dual grid, so surfaces stay crack-free across refinement levels. For each selected cell array it outputs a block of polygonal surface at VolumeFractionValue (multiplied by 255 internally), optionally capped where the material meets the domain boundary. Use it to visualize material boundaries in CTH-style AMR data; for meshes or image data use contour.

Common mistakes and assumptions:

  • Volume fractions are expected as unsigned char 0-255 (as the Spy Plot reader produces by default); VolumeFractionValue is a fraction of 1 and is multiplied by 255, so 0.5 means a stored value of 127.5.
  • Nothing is produced until at least one SelectMaterialArrays entry is given.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMRContour. Identity: filters/AMRDualContour. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Capping If this property is on, the the boundary of the data set is capped. {"type":"boolean"} native initialisation / omitted false
DegenerateCells If this property is on, a transition mesh between levels is created. {"type":"boolean"} native initialisation / omitted false
MergePoints Use more memory to merge points on the boundaries of blocks. {"type":"boolean"} native initialisation / omitted false
MultiprocessCommunication If this property is off, each process executes independently. {"type":"boolean"} native initialisation / omitted false
SelectMaterialArrays This property specifies the cell arrays from which the contour filter will compute contour cells. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SkipGhostCopy A simple test to see if ghost values are already set properly. {"type":"boolean"} native initialisation / omitted false
Triangulate Use triangles instead of quads on capping surfaces. {"type":"boolean"} native initialisation / omitted false
VolumeFractionValue This property specifies the values at which to compute the isosurface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRContour",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAMRDualClip#

AMR Dual Clip (vtkPVAMRDualClip) clips non-overlapping AMR volume-fraction data with the dual grid and outputs, per selected material array, an unstructured grid of tetrahedra covering the region where the fraction exceeds VolumeFractionValue (multiplied by 255 internally). Level transitions are handled and interior tetrahedra can be decimated to keep the mesh small. Use it to get a volumetric mesh of a material region; use pvAMRContour for its surface only.

Common mistakes and assumptions:

  • Volume fractions are expected as unsigned char 0-255 (as the Spy Plot reader produces by default); only unsigned char arrays are accepted here.
  • The native class documentation states that it does not copy attributes yet; check which arrays the clipped mesh carries before relying on them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMRDualClip. Identity: filters/AMRDualClip. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
InternalDecimation If this property is on, internal tetrahedra are decimation {"type":"boolean"} native initialisation / omitted false
MergePoints Use more memory to merge points on the boundaries of blocks. {"type":"boolean"} native initialisation / omitted false
MultiprocessCommunication If this property is off, each process executes independently. {"type":"boolean"} native initialisation / omitted false
SelectMaterialArrays This property specifies the cell arrays from which the clip filter will compute clipped cells. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VolumeFractionValue This property specifies the values at which to compute the isosurface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRDualClip",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAMRFragmentIntegration#

Integrates fragments previously labelled by pvAMRConnectivity: for each material array it reads the RegionId-<array name> cell labels and outputs a table (one block per material in a multiblock) with "Fragment ID", "Fragment Volume", "Fragment Mass" and one "Volume Weighted <name>" or "Mass Weighted <name>" column per selected array. Fragment volume is the volume fraction (0-255 scaled) times cell volume; mass is the sum of the chosen mass array. Use it for size and mass statistics of debris or droplets; pvAMRFragmentsFilter runs connectivity and integration together.

Common mistakes and assumptions:

  • The input must come from pvAMRConnectivity with the same material arrays; otherwise the native filter reports that no RegionId array exists.
  • Give exactly one mass array per material array, in the same order; the native code pairs them by position.
  • Mass arrays are summed as they are, so they must hold mass per cell, not density.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMRFragmentIntegration. Identity: filters/AMRFragmentIntegration. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the volume input of the filter. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SelectMassArrays This property specifies the cell arrays from which the analysis will determine fragment mass {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectMassWeightedArrays This property specifies the cell arrays from which the analysis will determine mass weighted average values {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectMaterialArrays This property specifies the cell arrays from which the analysis will determine fragments {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectVolumeWeightedArrays This property specifies the cell arrays from which the analysis will determine volume weighted average values {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRFragmentIntegration",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAMRFragmentsFilter#

One-step fragment analysis for non-overlapping AMR material data: it runs AMR connectivity (always resolving fragments across blocks), then fragment integration and optionally surface extraction, with one shared VolumeFractionValue. Output port 0 holds the fragment tables ("Fragment ID", "Fragment Volume", "Fragment Mass" and one "Volume Weighted <name>" or "Mass Weighted <name>" column per selected array) when IntegrateFragments is on; port 1 holds the fragment surfaces when ExtractSurface is on, made watertight by the AMR dual contour if UseWatertightSurface is set or by ExtractCTHPart otherwise. Select a port with {"node": id, "port": n}.

Common mistakes and assumptions:

  • The shared VolumeFractionValue is used raw by the connectivity step but scaled by 255 by the contour step, so labels and surfaces can disagree slightly near the threshold.
  • Give one mass array per material array, in the same order.
  • With default settings port 1 is empty; enable ExtractSurface to get surfaces.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMRFragmentsFilter. Identity: filters/AMRFragmentsFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the volume input of the filter. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ExtractSurface Whether or not to extract a surface from this data {"type":"boolean"} native initialisation / omitted false
IntegrateFragments Whether or not to integrate fragments in this data {"type":"boolean"} native initialisation / omitted false
SelectMassArrays This property specifies the cell arrays from which the analysis will determine fragment mass {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectMassWeightedArrays This property specifies the cell arrays from which the analysis will determine mass weighted average values {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectMaterialArrays This property specifies the cell arrays from which the analysis will determine fragments {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectVolumeWeightedArrays This property specifies the cell arrays from which the analysis will determine volume weighted average values {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseWatertightSurface Whether the extracted surface should be watertight or not {"type":"boolean"} native initialisation / omitted false
VolumeFractionValue This property specifies the values at which to compute the isosurface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRFragmentsFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAMRGaussianPulseSource#

Generates a small synthetic overlapping AMR dataset (vtkOverlappingAMR) with two levels: a root block of 6 × 6 (× 6) points starting at (-2, -2, 0) with spacing RootSpacing, plus two refined patches. Cell arrays are "Gaussian-Pulse" = PulseAmplitude · exp(-Σ((x - origin)/width)²) and "Centroid". Use it to test AMR pipelines and readers (compare with pvXMLUniformGridAMRReader); it is not physical data.

Common mistakes and assumptions:

  • The pulse origin and width are in the same coordinates as the grid; with the default spacing 0.5 the root block spans only [-2, 0.5] in x and y, so a pulse placed far outside is invisible.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: AMRGaussianPulseSource. Identity: sources/AMRGaussianPulseSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Dimension Sets the desired dimension for the AMR dataset to generate. {"type":"enum","values":["2D","3D"]} native initialisation / omitted "2D"
PulseAmplitude Sets the amplitude of the pulse {"maximum":1.0,"minimum":0.0001,"type":"number"} native initialisation / omitted 0.0001
RefinementRatio Factor by which the cell size shrinks from the root level to the refined level: with 2, each refined cell is half the root cell size in every direction. Larger ratios give finer patches and more cells. The native documentation repeats the Dimension text by mistake. {"type":"enum","values":["2","3","4"]} native initialisation / omitted "2"
RootSpacing Set the spacing at level 0. {"type":"number"} native initialisation / omitted 1
XPulseOrigin Set x-coordinate for the pulse origin {"maximum":1.0,"minimum":-1.0,"type":"number"} native initialisation / omitted -1.0
XPulseWidth Width of the Gaussian pulse along x: the distance from the pulse centre at which the value drops to 1/e of the amplitude along that axis. Larger widths give a broader, smoother pulse. The native wording "x-coordinate for the pulse Width" is misleading. {"maximum":10.0,"minimum":0.5,"type":"number"} native initialisation / omitted 0.5
YPulseOrigin Set y-coordinate for the pulse origin {"maximum":1.0,"minimum":-1.0,"type":"number"} native initialisation / omitted -1.0
YPulseWidth Width of the Gaussian pulse along y: the distance from the pulse centre at which the value drops to 1/e of the amplitude along that axis. Larger widths give a broader, smoother pulse. The native wording "x-coordinate for the pulse Width" is misleading. {"maximum":10.0,"minimum":0.5,"type":"number"} native initialisation / omitted 0.5
ZPulseOrigin Set z-coordinate for the pulse origin {"maximum":1.0,"minimum":-1.0,"type":"number"} native initialisation / omitted -1.0
ZPulseWidth Width of the Gaussian pulse along z: the distance from the pulse centre at which the value drops to 1/e of the amplitude along that axis. Larger widths give a broader, smoother pulse. Used only for 3D output. The native wording "x-coordinate for the pulse Width" is misleading. {"maximum":10.0,"minimum":0.5,"type":"number"} native initialisation / omitted 0.5

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMRGaussianPulseSource"
}

pvAMReXBoxLibGridReader#

Reads AMReX/BoxLib plotfiles (directories named like plt00000) into a hierarchical-box (overlapping AMR) dataset of cell-centred grid variables, levels 0 to Level. Listing several plotfile directories in FileNames makes a time series. Use it for AMReX codes such as Castro, Nyx, MAESTROeX or PeleC; use pvAMReXBoxLibParticlesReader for the particles stored in the same plotfiles.

Common mistakes and assumptions:

  • Level defaults to 1, so only the two coarsest levels are loaded; raise it to see the finest data.
  • Each FileNames entry is a plotfile directory, not the Header file inside it.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMReXBoxLibGridReader. Identity: sources/AMReXGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Select the cell arrays to read load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EnableCaching Keep AMR blocks that have already been read in memory, so later updates that change the level or array selection, or revisit a time, do not reread them from disk. It does not change the data produced. {"type":"boolean"} native initialisation / omitted false
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Level This property specifies the desired level of resolution that will be visible. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus Select the point arrays to read load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMReXBoxLibGridReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvAMReXBoxLibParticlesReader#

Reads particles stored in AMReX plotfiles, producing point data (polydata blocks) with the selected particle components as point arrays; ParticleType names the particle container subdirectory inside each plotfile (ParaView default "particles"). It is a distributed reader. Several plotfile directories form a time series. Use pvAMReXBoxLibGridReader for the grid variables of the same plotfiles.

Common mistakes and assumptions:

  • ParticleType must match the subdirectory name in the plotfile (e.g. DM or Tracer for some codes); a wrong name yields no particles.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AMReXBoxLibParticlesReader. Identity: sources/AMReXParticlesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of plotfiles to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
ParticleType Set the type of particles to read. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
PointArrayStatus Select the point arrays to read load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAMReXBoxLibParticlesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvANLHaloFinder#

Cosmology halo finder from the HACC CosmoTools library (vtkPANLHaloFinder). Input is an unstructured grid of particles with point arrays vx, vy, vz and id, as read by pvGenericIOReader. It links particles closer than Linkinglength (in units of the mean interparticle spacing) into friends-of-friends halos of at least FOFparticlethreshold particles. Port 0 returns the particles with fof_halo_tag (-1 outside halos), port 1 one point per halo with mass, centre of mass, mean velocity, velocity dispersion and centre, and port 2 subhalos when FindSubhalos is on.

Common mistakes and assumptions:

  • Boxsize, Seedparticles and ParticleMass must match the simulation: the interparticle spacing that Linkinglength is measured in is Boxsize / Seedparticles, and the ParaView defaults are example values.
  • Positions must lie in [0, Boxsize); others are wrapped periodically.
  • Centre finding other than None can be very slow on large halos.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ANLHaloFinder. Identity: filters/ANLHaloFinder. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AlphaFactor A tuning parameter of subhalo finding. This controls how aggressively small suhalos will be grown. Alpha factor of 1.0 is the least agrressive. Only used if subhalo finding is enabled. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
BetaFactor A tuning parameter of subhalo finding. This controls how saddle points between subhalos are treated. Larger values allow identification of smaller scale structures such as tails. Only used if subhalo finding is enabled. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Boxsize The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension (only positive positions are allowed in the input, or they are wrapped around). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
CenterFindingMethod Set the method used to determine the halo "center". {"type":"enum","values":["None","Most Bound Particle","Most Connected Particle","Hist Center Finding"]} native initialisation / omitted "None"
Deut Sets the Deut parameter of the center finding algorithms. This parameter comes from the simulation input and is not needed if Center Finding Method is set to None. {"type":"number"} native initialisation / omitted 1
DistanceConversionFactor Some input files may have the world coordinates scaled from what the halo finder expects. This parameter is the conversion factor that will be multiplied by the positions of all particles. {"type":"number"} native initialisation / omitted 1
FOFparticlethreshold Minimum number of particles (threshold) needed before a group is called a friends-of-friends (FOF) halo. {"minimum":1,"type":"integer"} native initialisation / omitted 1
FindSubhalos Turn this on to also find subhalos in halos of sufficient size. See the advanced parameters to set subhalo finder options. {"type":"boolean"} native initialisation / omitted false
Hubble Sets the Hubble parameter of the center finding algorithms. This parameter comes from the simulation input and is not needed if Center Finding Method is set to None. {"type":"number"} native initialisation / omitted 1
Linkinglength Linking length measured in units of interparticle spacing and is dimensionless. Used to link particles into halos for the friends-of-friends (FOF) algorithm. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
MassConversionFactor For some inputs the particle mass may need to be converted before the halo finder can be run. This is the number that is multiplied by the particle mass. {"type":"number"} native initialisation / omitted 1
MinimumSubhaloSize A subhalo candidate must have at least this many particles to be a subhalo. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Minimumsizeforsuhalofinding The miminum sized halo to run the subhalo finder of to subdivide further. Only used if subhalo finding is enabled. {"minimum":0,"type":"integer"} native initialisation / omitted 0
NMin The minimum number of close neighbors for a halo candidate to include a particle. If this many particles in the halo are close enough to the particle, then the particle is considered inside the halo. {"minimum":1,"type":"integer"} native initialisation / omitted 1
NumberofNeighbors The nearest X particles will be used to determine the local density in the subhalo finder where X is the value of this parameter. Only used if subhalo finding is enabled. {"minimum":1,"type":"integer"} native initialisation / omitted 1
OmegaDM Sets the OmegaDM parameter of the center finding algorithms. This parameter comes from the simulation input and is not needed if Center Finding Method is set to None. {"type":"number"} native initialisation / omitted 1
OmegaNU Sets the OmegaNU parameter of the center finding algorithms. This parameter comes from the simulation input and is not needed if Center Finding Method is set to None. {"type":"number"} native initialisation / omitted 1
Overlap The space (in rL units) to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation. Called DeadSize in the hacc config files. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ParticleMass The mass of each particle. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
RedShift Sets the Redshift parameter of the center finding algorithms. This parameter comes from the simulation input and is not needed if Center Finding Method is set to None. {"type":"number"} native initialisation / omitted 1
SPHNeighbors A parameter of the subhalo finder. Only used if subhalo finding is enabled. {"type":"integer"} native initialisation / omitted 1
Seedparticles Number of seeded particles in one dimension. Therefore, total simulation particles is np^3 (cubed). {"minimum":0,"type":"integer"} native initialisation / omitted 0
SmoothingLength Sets the smoothing length used by some of the center finding techniques. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvANLHaloFinder",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvANLSubhaloFinder#

Runs the CosmoTools subhalo finder (vtkPANLSubhaloFinder) on halos already found by pvANLHaloFinder: the input is that filter's port 0 particles with vx, vy, vz, id and fof_halo_tag. Port 0 returns the particles with a subhalo_tag array (-1 outside subhalos) and port 1 one point per subhalo with mass, centre of mass, mean velocity and velocity dispersion. Mode chooses all halos, halos larger than SizeThreshold, or only the halo ids in HalosToProcess.

Common mistakes and assumptions:

  • Feed it pvANLHaloFinder output port 0; plain particle data lack fof_halo_tag.
  • Use the same Boxsize, Seedparticles and ParticleMass as the halo finder.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ANLSubhaloFinder. Identity: filters/ANLSubhaloFinder. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AlphaFactor A tuning parameter of subhalo finding. This controls how aggressively small suhalos will be grown. Alpha factor of 1.0 is the least agrressive. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
BetaFactor A tuning parameter of subhalo finding. This controls how saddle points between subhalos are treated. Larger values allow identification of smaller scale structures such as tails. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Boxsize The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension (only positive positions are allowed in the input, or they are wrapped around). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
HalosToProcess This list of halo ids which will be processed (if they exist in the data) by the filter when in 'Only Specified Halos' mode. {"items":{"minimum":0,"type":"integer"},"type":"array"} native initialisation / omitted [0]
Linkinglength Linking length measured in units of interparticle spacing and is dimensionless. Used to link particles into halos for the friends-of-friends (FOF) algorithm. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
MinimumSubhaloSize A subhalo candidate must have at least this many particles to be a subhalo. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Mode This property specifies which halos the filter will process. When 'All Halos' is selected, all input halos will be processed. When 'Only Halos Larger Than Threshold' is selected, only halos with more than SizeThreshold particles will be processed. When 'Only Specified Halos' is selected, the halos whose ids are in the HalosToProcess list will be used. {"type":"enum","values":["All Halos","Halos Larger Than Threshold","Only Specified Halos"]} native initialisation / omitted "All Halos"
NumberofNeighbors The nearest X particles will be used to determine the local density in the subhalo finder where X is the value of this parameter. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Overlap The space (in rL units) to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation. Called DeadSize in the hacc config files. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ParticleMass The mass of each particle. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
SPHNeighbors A parameter of the subhalo finder. {"type":"integer"} native initialisation / omitted 1
SizeThreshold This is the minimum size of a halo that will be processed if the filter is in 'Halos Larger Than Threshold' mode. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvANLSubhaloFinder",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAVSUCDReader#

Reads AVS Unstructured Cell Data files (.inp, ASCII or binary) into an unstructured grid with optional point (node) and cell arrays. Several files in FileNames form a time series. Use it for meshes and results exported in AVS UCD form by FE or CFD tools.

Common mistakes and assumptions:

  • Only the arrays named in the file are available; coordinates are used as written, with no unit conversion.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: AVSUCDReader. Identity: sources/AVSucdSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-data components in the UCD file to read as cell arrays. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-data components in the UCD file to read as point arrays. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAVSUCDReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvAdaptiveCosmoCore#

Reads LANL cosmo-format particle data that an adaptive-sampling preprocessor split into resolution levels (vtkACosmoReader, extension .cosmo). The output is a multiblock with one block per level (block 0 empty), each holding particle unstructured grids; Level chooses how many levels to load (1 is the coarsest). Use pvCosmoReader for ordinary single-resolution cosmo or Gadget files.

Common mistakes and assumptions:

  • File names must follow the preprocessor pattern <base>.<process>.<levels>.cosmo; a dot elsewhere in the path, for example in a folder name, breaks this parsing.
  • Data sampled in parallel (process number above 0) are rejected by the reader.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AdaptiveCosmoCore. Identity: sources/AdaptiveCosmoCore. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoxSize The box side length is used to wrap particles around if they exceed rL (or less than 0) in any dimension. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ByteSwap If checked, the data will be read and byte-swapped. {"type":"boolean"} native initialisation / omitted false
FileName The list of files to be read by the reader. The list is treated as a sequence as per a predefined adaptive structure generated from a preprocessor. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Level Specify the desired level of resolution. {"maximum":100,"minimum":1,"type":"integer"} native initialisation / omitted 1
TagSize Width of the integer particle id (tag) stored with each particle: 32-bit or 64-bit. It must match how the file was written, otherwise records are misaligned and positions and velocities are garbage. {"type":"enum","values":["32-bit","64-bit"]} native initialisation / omitted "32-bit"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAdaptiveCosmoCore",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvAdaptiveResampleToImage#

Resamples any dataset onto several image (vtkImageData) blocks, output as a vtkPartitionedDataSet: a k-d tree splits the input points into at least NumberOfImages regions (rounded up to a power of two; 0 means one per MPI process, so one in serial), and each region is sampled with SamplingDimensions points, so densely populated regions get finer spacing. Points outside the input are marked invalid, as with pvResampleToImage. Use it to obtain regular grids of unevenly distributed data for volume rendering or image analysis; use pvResampleToImage for one image over the whole domain.

Common mistakes and assumptions:

  • Each block has its own spacing and origin; do not treat the blocks as one uniform grid.
  • The sample count is the number of blocks times the product of SamplingDimensions; 8 blocks of 64 × 64 × 64 already give about 2 million points.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AdaptiveResampleToImage. Identity: filters/AdaptiveResampleToImage. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberOfImages Specify the number of partitions to split the dataset into. Set to 0 to indicate that the partitions should match the number of ranks. {"minimum":0,"type":"integer"} native initialisation / omitted 0
SamplingDimensions Number of sample points along x, y and z in each output image block, as [nx, ny, nz]. Every block uses the same counts across its own region's bounds, so the spacing differs between blocks. More points resolve finer detail at a cost proportional to nx × ny × nz per block. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAdaptiveResampleToImage",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAddFieldArrays#

Deprecated name (since ParaView 5.13, removal planned for 5.14) of pvFieldArraysFromFile, with the same behaviour: the input passes through and the field-data arrays of a legacy VTK file (.vtk) are attached to it, to every block of a composite input. Use pvFieldArraysFromFile in new documents.

Common mistakes and assumptions:

  • Documents using this id will need updating when ParaView removes the alias.
  • Only field data is added, never point or cell arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AddFieldArrays. Identity: filters/AddFieldArrays. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file to read to get arrays Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

onVisit commands:

{
  "Reload": {
    "command": "Modified",
    "native": "Reload"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAddFieldArrays",
  "inputs": {
    "Input": "UPSTREAM_Input"
  },
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["Reload"]. Commands run in this authored order before the update.

pvAggregateDataset#

Parallel data-movement filter: gathers the pieces of a distributed dataset onto NumberOfTargetProcesses MPI processes (ParaView default 1), leaving the other processes empty; VTK documents it for polydata and unstructured grids. Use it in MPI runs to reduce the number of pieces before writing or rendering a modest result. In a serial run there is only one process and the data pass through. Input must be a single, non-composite dataset.

Common mistakes and assumptions:

  • Gathering a large dataset onto few processes can exhaust their memory.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AggregateDataset. Identity: filters/AggregateDataSet. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberOfTargetProcesses This property specifies the number of target processes to aggregate the dataset onto. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAggregateDataset",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAlignImageOrigins#

Gives every image block of a composite (multiblock or partitioned) image dataset the same origin and rewrites each block's extent relative to it, so blocks that are parts of one image share a global index space and extent-based operations such as extractSubset behave consistently across blocks. All images must have the same spacing; the shared origin is the minimum corner of all blocks, shifted so that corner gets index MinimumExtent. Point positions do not change.

Common mistakes and assumptions:

  • Blocks with different spacing cannot be aligned; ParaView reports an error.
  • Blocks whose origins are not offset by whole multiples of the spacing cannot keep their positions; the native code reports them as misaligned.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AlignImageOrigins. Identity: filters/AlignImageOrigin. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Align Image Origins filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet); image data (uniform rectilinear grids) (vtkImageData); partitioned dataset collections (vtkPartitionedDataSetCollection); partitioned datasets (vtkPartitionedDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet","vtkImageData","vtkPartitionedDataSetCollection","vtkPartitionedDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MinimumExtent Specify the global minimum extent to use. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAlignImageOrigins",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAngularPeriodicFilter#

Rebuilds a full rotor or periodic set of sectors from a computed sector: selected blocks are copied and rotated about an axis (X, Y or Z through Center) by multiples of an angle, rotating point coordinates and 3- and 9-component arrays (vectors and tensors) consistently. Each selected leaf becomes a multipiece of rotated copies, the first being the original; with IterationMode Maximum (ParaView default) there are round(360 / angle) copies, otherwise NumberOfPeriods. The angle is RotationAngle in degrees (default 10) or read in radians from a field array. VTK supports polydata, structured and unstructured grid leaves.

Common mistakes and assumptions:

  • For multiblock input only blocks listed in BlockIndices are rotated; with none listed the output is an unchanged copy. A single non-composite dataset is always processed.
  • Rotated arrays are computed on the fly by default (ComputeRotationsOnTheFly), saving memory but costing time at every access.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AngularPeriodicFilter. Identity: filters/AngularPeriodicFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Periodic filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Axis This property specifies the axis of rotation {"type":"enum","values":["Axis X","Axis Y","Axis Z"]} native initialisation / omitted "Axis X"
BlockIndices This property lists the ids of the blocks to make periodic from the input multiblock dataset. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
Center This property specifies the 3D coordinates for the center of the rotation. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ComputeRotationsOnTheFly Specify whether the rotations should be computed on-the-fly, which is compute intensive, or if the arrays should be explicitly generated and stored, at the cost of using more memory. {"type":"boolean"} native initialisation / omitted false
IterationMode This property specifies the mode of iteration, either a user-provided number of periods, or the maximum number of periods to rotate to 360 degrees. {"type":"enum","values":["Manual","Maximum"]} native initialisation / omitted "Manual"
NumberOfPeriods This property specifies the number of iteration {"type":"integer"} native initialisation / omitted 1
RotationAngle Rotation angle in degree. {"type":"number"} native initialisation / omitted 1
RotationArrayName Field array name that contains the rotation angle in radians. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
RotationMode This property specifies the mode of rotation, either from a user provided angle or from an array in the data. {"type":"enum","values":["Direct Angle","Array Value"]} native initialisation / omitted "Direct Angle"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAngularPeriodicFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAnimateModes#

Turns modal-analysis results, where each 'time step' of the input (e.g. Exodus) is really a mode shape, into a vibration animation: ModeShape (1-based) picks the mode, and the points are displaced by DisplacementMagnitude × cos(2π t) × the displacement vectors, with t the requested time in [0, 1]. Output keeps the input structure, has no discrete time steps and adds mode_shape field arrays. Use pvWarpByVector for a single static displacement.

Common mistakes and assumptions:

  • DisplacementPreapplied is true by ParaView default, so one displacement is subtracted; set it false if the input coordinates are the undeformed geometry.
  • Requested times are treated as a phase in [0, 1], not as physical time.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnimateModes. Identity: filters/AnimateModes. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AnimateVibrations Whether ParaView advertises the [0, 1] phase range as the filter's time range. With false it no longer advertises that range, but the displacement is still scaled by cos(2π t) at whatever time is requested, and Schemaxis always requests the scene time. At time 0 the amplitude is the full DisplacementMagnitude; at any other requested time the shape is scaled by cos(2π t) regardless of this setting. ParaView's own text says that the requested time is used only when the option is set; the source does not do that. {"type":"boolean"} native initialisation / omitted false
DisplacementMagnitude Specify a scale factor to apply the displacements. {"type":"number"} native initialisation / omitted 1
DisplacementPreapplied Specify whether displacements are pre-applied. {"type":"boolean"} native initialisation / omitted false
ModeShape Specify which mode shape to animate. {"type":"integer"} native initialisation / omitted 1
Vectors Specify the displacement vectors array {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnimateModes",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAnnotateAttributeData#

Produces a one-cell text table showing Prefix followed by one value of an array: element ElementId of the chosen point, cell, field or row array, taken from MPI rank ProcessId. Use it to label an image with a probe value or a global quantity such as a residual. Input must be a non-composite dataset or a table; ParaView needs its Python support for this filter.

Common mistakes and assumptions:

  • Composite datasets are not supported; extract a block first (extractBlock).
  • ElementId indexes the array's tuples from 0; check the index after any filter that reorders points or cells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnnotateAttributeData. Identity: filters/AnnotateAttributeData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input of the filter. To avoid the complications/confusion when identifying elements in a composite dataset, this filter doesn't support composite datasets currently. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ElementId Set the element index to annotate with. {"type":"integer"} native initialisation / omitted 1
Prefix Text that is used as a prefix to the field value {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ProcessId Set the process rank to extract element from. {"minimum":0,"type":"integer"} native initialisation / omitted 0
SelectInputArray This property indicates the name of the array from which to obtain the annotation value. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnnotateAttributeData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAnnotateGlobalData#

Turns one value of a field-data (global) array into a text table: Prefix, the value formatted with Format, then Suffix, e.g. "Value is: 1.234e+05". If the array has one entry per time step it is indexed by the current time step, so the text follows the animation. The output is a one-row text table for display as an annotation, not a dataset to process further.

Common mistakes and assumptions:

  • Only field (global) arrays qualify; point and cell arrays are not listed.
  • Format is a C printf pattern and must match the array type: %g/%f/%e for floating point, %d for integers; a mismatch makes ParaView warn and drop the value.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnnotateGlobalData. Identity: filters/AnnotateGlobalData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Set the input of the filter. Accepted data: any data object (vtkDataObject); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one field-data array with 1 component. True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Format Text that is used as the C format string used by the snprintf string formatter used to convert a global data value to a string. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Prefix Text that is used as a prefix to the field value. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SelectArrays Choose array that is going to be displayed. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Suffix Text that is used as a suffix to the field value. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnnotateGlobalData",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvAnnotateSelection#

Adds a string array named "Annotate Selection" to the points or cells of Input, labelling each element selected by node i of the Selection with Labels[i] and every other element with DefaultLabel. Use it to tag regions (e.g. inlet, outlet) for colouring or export. The output is the input dataset with the extra array.

Common mistakes and assumptions:

  • The number of Labels must equal the number of selection nodes; otherwise ParaView warns and the output stays empty.
  • Only POINT or CELL selections whose nodes hold element indices are labelled; convert other selection types to INDICES with pvConvertSelection.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnnotateSelection. Identity: filters/AnnotateSelection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Required data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input that provides the selection object. Accepted data: selections (vtkSelection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DefaultLabel Specify the default label used for unlabelized data. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Labels Associated for each selection node an label. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnnotateSelection",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Selection": "UPSTREAM_Selection"
  }
}

pvAnnotateTime#

Source (no input) that produces a one-cell table whose Text column holds the requested animation time formatted with Format, e.g. "Time: 0.250000". It reports the time the pipeline asks it to update, not a dataset's time; when no time is requested the text is "?". Use pvAnnotateTimeFilter to label the time of a particular dataset, and pvText for fixed text.

Common mistakes and assumptions:

  • Format uses fmt syntax with the argument {time}; legacy printf %f is converted with a warning.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnnotateTime. Identity: sources/TimeToTextConvertorSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Format The value of this property is a format string used to display the input time. The format string is specified using fmt style. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnnotateTime"
}

pvAnnotateTimeFilter#

Produces a one-row text table showing the input's current time, transformed as time × Scale + Shift and formatted with an fmt-style Format such as "Time: {time:.3f} s". Use it to label animations or images with physical time. It needs a time-dependent input; pvAnnotateTime is the source variant that needs no input.

Common mistakes and assumptions:

  • Format uses fmt/Python brace syntax with the name time; old printf patterns such as "%f" are converted with a warning.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AnnotateTimeFilter. Identity: filters/TimeToTextConvertor. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset for which to display the time. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Format The value of this property is a format string used to display the input time. The format string is specified using fmt style {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Scale The factor by which the input time is scaled. {"type":"number"} native initialisation / omitted 1
Shift The amount of time the input is shifted (after scaling). {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAnnotateTimeFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAppendArcLength#

Deprecated alias of pvPolylineLength: ParaView 5.13 marks AppendArcLength for removal in 5.14. It runs the same vtkAppendArcLength filter, adding a point array arc_length with the distance along each polyline from its first point (0 for points of other cell types).

Common mistakes and assumptions:

  • Use pvPolylineLength in new workflows; this identifier is expected to disappear when ParaView 5.14 is absorbed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendArcLength. Identity: filters/AppendArcLength. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendArcLength",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAppendAttributes#

Combines the point and cell arrays of several inputs that share the same geometry: the output copies the first input's geometry and adds every array from all inputs. Inputs whose point or cell count differs from the first are ignored for that attribute type, and a repeated array name gets the suffix input<n>. Use it to gather fields computed on separate branches of one mesh (e.g. gradient and cellSize results) into one node; use append or pvAppendDatasets to join different meshes.

Common mistakes and assumptions:

  • Only counts are checked, not point order or coordinates; inputs from differently numbered meshes silently attach values to the wrong points.
  • Duplicate array names are renamed, not replaced; check names before later nodes refer to them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendAttributes. Identity: filters/AppendAttributes. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: This property specifies the input to the Append Attributes filter. Accepted data: any data object (vtkDataObject). True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendAttributes",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvAppendDatasets#

Merges the meshes of several datasets into one. With OutputDataSetType Unstructured Grid (ParaView default) inputs of almost any type are appended; with Polygonal Mesh only polydata inputs are merged and the rest are left out. Only point and cell arrays present on every input are kept, and coincident points are not merged. Use it to combine separate nodes, e.g. two clipped regions; append is the curated equivalent, pvAppendGeometry keeps polydata, and merge or pvMergeBlocks flatten one composite input.

Common mistakes and assumptions:

  • Composite (multiblock) inputs are not accepted; flatten them with merge first.
  • Arrays missing from any one input are dropped; make names agree, e.g. with pvRenameArrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendDatasets. Identity: filters/Append. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: This property specifies the datasets to be merged into a single dataset by the Append Datasets filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OutputDataSetType Determines the output type produced by this filter. Only input datasets compatible with the output type will be merged in the output. For example, if the output type is "Polygonal Mesh", then inputs of type "Image Data", "StructuredGrid", etc. will not be merged. On the other hand, if the output type is "Unstructured Grid", then inputs of almost any type will be merged in the output. Defaults to "Unstructured Grid". {"type":"enum","values":["Polygonal Mesh","Unstructured Grid"]} native initialisation / omitted "Polygonal Mesh"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendDatasets",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvAppendGeometry#

Appends several polygonal datasets (vtkPolyData) into one polydata, keeping vertices, lines, polygons and strips; only arrays present on every input survive and points are not merged. Use it to combine surfaces or lines from several nodes while staying polydata, e.g. for a surface writer; appendGeometry is the curated equivalent and pvAppendDatasets accepts mixed types.

Common mistakes and assumptions:

  • Every input must be polydata; extract surfaces of volume meshes first.
  • Arrays that exist on only some inputs disappear from the result.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendGeometry. Identity: filters/AppendPolyData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Set the input to the Append Geometry filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendGeometry",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvAppendLocationAttributes#

Adds point coordinates and cell centres as data arrays: PointLocations (3-component point array, a copy of each point's coordinates) and CellCenters (3-component cell array). Geometry and existing arrays are unchanged. Use it when a calculator, export or table needs coordinates as ordinary arrays, e.g. to compute a radius or write x, y, z to CSV. This is the old name of the same ParaView filter.

Common mistakes and assumptions:

  • ParaView 5.13 marks this proxy deprecated (renamed Coordinates, removal planned for 5.14); use pvCoordinates, which has the same behaviour and settings.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendLocationAttributes. Identity: filters/AppendLocationAttributes. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Append Location Attributes filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AppendCellCenters Adds a cell data array named CellCenters that is stores the centers of cells in the input. {"type":"boolean"} native initialisation / omitted false
AppendPointLocations Adds a point data array named PointLocations that is a copy of the point locations in the input. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendLocationAttributes",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAppendMolecule#

Appends one or more molecules (vtkMolecule) into a single molecule containing all atoms and bonds with their atom and bond data. The inputs must carry the same data arrays (same number and names). Use it to assemble a system from several molecule readers or pvConvertIntoMolecule nodes before bonding, rendering or export.

Common mistakes and assumptions:

  • VTK merges atoms at identical positions by default (MergeCoincidentAtoms, not exposed in ParaView), so overlapping copies of a structure collapse into one.
  • Inputs with differing atom or bond arrays are not reconciled; give all inputs the same arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendMolecule. Identity: filters/AppendMolecule. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: molecules (vtkMolecule). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMolecule"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendMolecule",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvAppendReduce#

Parallel data-movement filter (vtkReductionFilter with vtkAppendFilter as the post-gather helper): it gathers the pieces of a distributed dataset from all MPI processes and appends them into one unstructured grid on one process or on every process. Use it in MPI runs when a later step needs the whole dataset in one place; in a serial run there is only process 0, so it just appends the single piece. Input must be a non-composite vtkDataSet. To combine separate nodes use append or merge.

Common mistakes and assumptions:

  • Gathering a large mesh onto one process can exceed that process's memory.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendReduce. Identity: filters/AppendReductionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Reduction filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateProcessIds If true, the filter will generate vtkOriginalProcessIds arrays indicating the process id on which the cell/point was generated. {"type":"boolean"} native initialisation / omitted false
OnlyFrom If set to a non-negative value, then produce results using only the node Id specified. {"minimum":-1,"type":"integer"} native initialisation / omitted -1
PostGatherHelperName Set the algorithm that takes multiple inputs and produces a single reduced output. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ReduceTo Set the process to reduce to. {"minimum":0,"type":"integer"} native initialisation / omitted 0
ReductionMode Set the reduction mode. Reducing all data to one processor means that the destination process will have all data while each other process will still have it's own data. Moving all to one processor means that the destination process will have all data while other process have no data anymore. Reduce all data to all processors is self explanatory. {"type":"enum","values":["Reduce all data to one processor","Move all data to one processor","Reduce all data to all processors"]} native initialisation / omitted "Reduce all data to one processor"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendReduce",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvAppendSelections#

Combines several selections (vtkSelection), for example ID, block and threshold selections, into one (vtkAppendSelection). With no Expression the inputs are joined with OR; with an Expression such as "(A|B)&!C" the inputs, named by SelectionNames in input order, are combined with | (or), & (and), ^ (xor) and ! (not). InsideOut inverts the result. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.

Common mistakes and assumptions:

  • When Expression is set, give exactly one name per input; otherwise the native filter fails.
  • Inputs should use the same FieldType (all cells or all points); the filter does not check this.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AppendSelections. Identity: filters/AppendSelections. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: This property indicates the inputs to the AppendSelections filter. Accepted data: selections (vtkSelection). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AppendByUnion Allows by default to not append by union, so that an expression can be used. {"type":"boolean"} native initialisation / omitted false
Expression This property specifies the expression which defines the relation between the input selections. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
SelectionColors Specify color to use for each input selection. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
SelectionNames Specify names to use for each input selection. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAppendSelections",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvArrow#

Creates a 3-D arrow of total length 1 along +x from the origin: a cylindrical shaft joined to a conical tip, as polydata without normals. Use it as a glyph shape or annotation; scale and orient it with a transform, or use pvGlyph to place many arrows on vector data.

Common mistakes and assumptions:

  • Normals are not generated, so the arrow renders faceted; apply the normals operation for smooth shading.
  • TipLength, ShaftRadius and TipRadius are fractions of the unit arrow length, not absolute sizes.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Arrow. Identity: sources/ArrowSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Invert Inverts the arrow direction. {"type":"boolean"} native initialisation / omitted false
ShaftRadius This property specifies the radius of the shaft of the arrow (the cylinder). {"maximum":5.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ShaftResolution This property specifies the number of faces of the shaft of the arrow (the cylinder). As the resolution increases, the cylinder will become smoother. {"maximum":128,"minimum":3,"type":"integer"} native initialisation / omitted 3
TipLength This property specifies the length of the tip. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
TipRadius This property specifies the radius of the widest part of the tip of the arrow (the cone). {"maximum":10.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
TipResolution This property specifies the number of faces in the representation of the tip of the arrow (the cone). As the resolution increases, the cone will become smoother. {"maximum":128,"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvArrow"
}

pvAxes#

Creates three line segments along the x, y and z directions from Origin, as polydata with normals and a point scalar "Axes" (0 on the x line, 0.25 on y, 0.5 on z), so colouring by that array distinguishes the axes. Each line has length ScaleFactor, or runs from -ScaleFactor to +ScaleFactor when Symmetric is true. Use it as an orientation reference in a scene.

Common mistakes and assumptions:

  • The axis colours depend on the colour map applied to "Axes"; the native documentation's colour descriptions are inconsistent, so check the rendered result.
  • Lines are dataset geometry with no arrowheads or labels; scale them to the data with ScaleFactor.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Axes. Identity: sources/Axes. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Origin The values of this property set the X, Y, and Z coordinates of the origin of the axes. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ScaleFactor By default the axes lines have a length of 1 (or 1 in each direction, for a total length of 2, if value of the Symmetric property is 1). Increasing or decreasing the value of this property will make the axes larger or smaller, respectively. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Symmetric When this property is set to 1, the axes extend along each of the positive and negative directions for a distance equal to the value of the Scale Factor property. When set to 0, the axes extend only in the positive direction. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAxes"
}

pvAxisAlignedSlice#

Slices hyper tree grids and overlapping AMR data with an axis-aligned plane while keeping the input type, so a 3-D hyper tree grid becomes 2-D hyper tree grids. For hyper tree grids each entry of OffsetValues gives one slice and the output is a partitioned dataset collection; for AMR one slice at the plane is produced, at resolution Level. Use slice or pvSlice for ordinary meshes.

Common mistakes and assumptions:

  • Only vtkHyperTreeGrid and vtkOverlappingAMR inputs are accepted.
  • The cut plane must be axis-aligned; oblique normals are not supported.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: AxisAlignedSlice. Identity: filters/AxisAlignedSlice. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the slice filter. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid); overlapping AMR data (vtkOverlappingAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid","vtkOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CutFunction This property sets the parameters of the cut function. {"type":"typed proxy","choices":["Axis Aligned Plane"]} native initialisation / omitted {"type":"Axis Aligned Plane"}
Level Set maximum slice resolution. {"type":"integer"} native initialisation / omitted 1
OffsetValues The values in this property specify a list of current slice offset values. This can be used to create multiple slices with different centers. Each entry represents a new slice with its center shifted by the offset value. The 'Values Range' information is the range based on the global bounding box, not necessarily on the current slice geometry configuration. These offset values are added to the global offset value set through the "Offset" property. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Nested CutFunction → Axis Aligned Plane#

Syntax: {"type":"Axis Aligned Plane","options":{...}}. Native identity: implicit_functions/Axis Aligned Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
CutFunction.options.AlwaysSnapToNearestAxis When true, ParaView replaces Normal by the coordinate axis of its largest absolute component, so the plane is always perpendicular to x, y or z. The snapped normal is always positive ([-1, 0, 0] becomes [1, 0, 0]), and tied components are all set to 1 ([1, 1, 0] stays [1, 1, 0]) rather than resolved to one axis. When false, Normal is used as given. {"type":"boolean"} native initialisation / omitted false
CutFunction.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
CutFunction.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
CutFunction.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvAxisAlignedSlice",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvBDFReader#

Reads a Nastran Bulk Data File (.bdf) in free-field format into an unstructured grid. Only a small subset of entries is understood: GRID points, CTRIA3 triangles, PLOAD2 pressure loads (a cell array) and TITLE and TIME (field data); other entries such as CQUAD4 or CTETRA are skipped with a warning listing them. Use it for triangulated Nastran surfaces with pressure loads, not for general finite-element models.

Common mistakes and assumptions:

  • Fixed-field (8-character column) BDF files are not supported; convert them to free-field (comma-separated) format.
  • Check the reader's warning for skipped entries; a model with only quadrilaterals or solids yields points without cells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BDFReader. Identity: sources/BDFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the BDF reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBDFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvBYUReader#

Reads Movie.BYU geometry files (.g) into polydata made of polygons. Use it for legacy surface models in this format; companion displacement, scalar or texture files supported by vtkBYUReader are not exposed by the ParaView proxy, so only the geometry is read.

Common mistakes and assumptions:

  • Coordinates are used as written; check the unit before combining with other data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: BYUReader. Identity: sources/byureader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the BYU reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBYUReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvBlockIds#

Adds a cell array named BlockIdScalars to every block of a multiblock dataset, holding the index of the block (unsigned char), so blocks can be coloured, thresholded or counted by block. The input must be a vtkMultiBlockDataSet; structure and other arrays are unchanged. Use extractBlock to keep selected blocks instead.

Common mistakes and assumptions:

  • Partitioned dataset collections (e.g. from newer readers) are not multiblock; the input domain rejects them.
  • The index is a traversal counter, not the block name; keep names via the reader's block list.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BlockIds. Identity: filters/BlockIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Level Scalars filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBlockIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvBlockScalars#

Adds a cell array named BlockIdScalars to every block of a multiblock dataset, holding the index of the block (unsigned char), so blocks can be coloured, thresholded or counted by block. The input must be a vtkMultiBlockDataSet; structure and other arrays are unchanged. This is the old name of the same ParaView filter.

Common mistakes and assumptions:

  • ParaView 5.13 marks this proxy deprecated (renamed BlockIds, removal planned for 5.14); use pvBlockIds, which has the same behaviour and settings.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BlockScalars. Identity: filters/BlockIdScalars. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Level Scalars filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBlockScalars",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvBlockSelectionSource#

Creates a block selection: a vtkSelection naming whole blocks of a composite dataset by their flat (composite) index, so pvExtractSelection keeps just those blocks. Choose it when you know the numeric block indices; pvBlockSelectorsSelectionSource selects blocks by path, which is more robust, and extractBlock or pvExtractBlock extract blocks directly without a selection. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.

Common mistakes and assumptions:

  • Flat indices count every node of the composite tree in depth-first order, including the root (0) and intermediate multiblocks, so the first leaf is usually 1 or more.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BlockSelectionSource. Identity: sources/BlockSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Blocks The list of blocks that will be added to the selection produced by the selection source. The blocks are identified using their composite index (flat index). {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBlockSelectionSource"
}

pvBlockSelectorsSelectionSource#

Creates a block selection from selector paths (vtkPVSelectionSource with BLOCK_SELECTORS content): XPath-style expressions such as "/Root/internalMesh" or "//patch" evaluated against a data assembly of the composite dataset, by default ParaView's Hierarchy. Choose it over pvBlockSelectionSource when block names are known but indices may change. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.

Common mistakes and assumptions:

  • Block names in the Hierarchy assembly are made path-safe: characters other than letters, digits, '.', '-' and '_' are dropped, so "Level 0" becomes Level0.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BlockSelectorsSelectionSource. Identity: sources/BlockSelectorsSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BlockSelectors The list of blocks selectors that will be added to the selection produced by the selection source. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
BlockSelectorsAssemblyName Which data assembly the selectors are evaluated against: "Hierarchy" is the composite dataset's own block tree, available for every multiblock, partitioned collection or AMR dataset; "Assembly" is a reader-defined grouping (for example IOSS or CGNS families) that exists only when the data provide one. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBlockSelectorsSelectionSource"
}

pvBoundaryMeshQuality#

Extracts the boundary faces of a volume mesh as polydata and, for each face, measures its relation to the volume cell it belongs to: DistanceFromCellCenterToFaceCenter, DistanceFromCellCenterToFacePlane (both in dataset length units) and AngleFaceNormalAndCellCenterToFaceCenterVector in degrees. Use it to inspect near-wall cell size and skewness, e.g. first-cell height on CFD walls. Input must be a volumetric grid (unstructured, structured, rectilinear or image data); use pvMeshQuality for whole-cell shape metrics.

Common mistakes and assumptions:

  • The output contains only boundary faces, so it cannot be combined cell by cell with the volume mesh without the original cell ids.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BoundaryMeshQuality. Identity: filters/BoundaryMeshQuality. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Boundary Mesh Quality filter. Accepted data: unstructured grids (vtkUnstructuredGridBase); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid); curvilinear structured grids (vtkStructuredGrid); explicit structured grids (vtkExplicitStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGridBase","vtkImageData","vtkRectilinearGrid","vtkStructuredGrid","vtkExplicitStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AngleFaceNormalAndCellCenterToFaceCenterVector This property indicates whether the angle of face's plane normal and cell center to face center vector will be computed. {"type":"boolean"} native initialisation / omitted false
DistanceFromCellCenterToFaceCenter This property indicates whether the distance from cell center to face center will be computed. {"type":"boolean"} native initialisation / omitted false
DistanceFromCellCenterToFacePlane This property indicates whether the distance from cell center to face's plane will be computed. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBoundaryMeshQuality",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvBoundingRuler#

Creates a line along the input's bounding box, along X, Y or Z, or along an oriented bounding-box axis, so its length is the extent of the data along that axis. ParaView displays it as a measured ruler; in Schemaxis the output is a polydata line that can be rendered or measured. Use pvRuler for a ruler between two chosen points.

Common mistakes and assumptions:

  • Oriented-bounding-box axes need all points on one process; in MPI runs make sure the data fits on one rank.
  • The ruler graduations are a ParaView view representation and may not appear in Schemaxis renders; the geometry is a plain line.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: BoundingRuler. Identity: filters/RulerFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Axis Select along which axis the ruler should be aligned. Note: this filter requires that all points in the dataset to which it is applied be copied to a single rank when this option is set to any of the Oriented Bound Box options, so make sure the dataset can fit on one rank before applying this filter. {"type":"enum","values":["X Axis","Y Axis","Z Axis","Oriented Bounding Box Major Axis","Oriented Bounding Box Medium Axis","Oriented Bounding Box Minor Axis"]} native initialisation / omitted "X Axis"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBoundingRuler",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvBox#

Creates an axis-aligned box as polydata with normals and texture coordinates: six quadrilateral faces centred at Center with edge lengths XLength, YLength and ZLength. Use it as reference geometry, a bounding region or a simple test surface. For a box defined by minimum and maximum corners as a wireframe use pvOutlineSource.

Common mistakes and assumptions:

  • Faces are single quadrilaterals; slicing or probing them gives few samples. Use pvPlane or a triangulated mesh when resolution matters.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Box. Identity: sources/CubeSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center This property specifies the center of the box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
XLength This property specifies the length of the box in the X direction. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
YLength This property specifies the length of the box in the Y direction. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ZLength This property specifies the length of the box in the Z direction. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvBox"
}

pvCGNSSeriesReader#

Reads CFD General Notation System files (.cgns, ADF or HDF5 based) into a multiblock dataset organized by base and zone: each zone becomes a structured or unstructured grid and, with LoadPatches, its boundary-condition patches are added beside the volume mesh. Field arrays come from FlowSolution_t nodes as point, cell or face data, and several files in FileNames form a time series. Choose it for general CGNS solver output; use pvIOSSReader for CGNS files that the IOSS library supports, and pvCONVERGECFDCGNSReader for CONVERGE CGNS post files with parcels.

Common mistakes and assumptions:

  • In the VTK reader every point, cell and face array starts disabled, so an unconfigured node usually has geometry but no fields; name the arrays in CellArrayStatus or PointArrayStatus.
  • Only the first base is read by default; list further bases in Bases.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: CGNSSeriesReader. Identity: sources/CGNSSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Bases Names of the CGNS bases (CGNSBase_t nodes, the top-level groups that hold zones) to read; each selected base becomes one block of the output. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CacheConnectivity When true, the element connectivity of unstructured zones is read once and reused from memory at later time steps instead of being re-read at every step. It shortens transient reads on a fixed mesh at the cost of memory and does not change the values read. {"type":"boolean"} native initialisation / omitted false
CacheMesh When true, zone point coordinates are read once, stored per base and zone, and reused at later time steps instead of being re-read. It saves read time for transient results on a static mesh at the cost of memory. {"type":"boolean"} native initialisation / omitted false
CellArrayStatus Names of cell-centred FlowSolution_t fields (CellCenter location) to load as cell data on the zone blocks. Used when DataLocation is "Cell Data"; face-centred fields are chosen in FaceArrayStatus instead. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CreateEachSolutionAsBlock Debug option: when true, every FlowSolution_t node of a zone is output as its own child block under that zone, instead of the solution for the current time step being attached to the zone mesh. VTK warns that the output may not be correct, so it is meant for inspecting file structure, not for analysis. {"type":"boolean"} native initialisation / omitted false
DataLocation Specifies whether to read cell or face information from the mesh. Face-based reading is only available if the element connectivity is defined with NGON_n element type. {"type":"enum","values":["Cell Data","Face Data"]} native initialisation / omitted "Cell Data"
DoublePrecisionMesh When true, mesh coordinates are stored as 64-bit doubles; false stores 32-bit floats and halves coordinate memory. When the file's precision differs from the requested one, the coordinates are converted while reading, which costs time. Field arrays are not affected. {"type":"boolean"} native initialisation / omitted false
FaceArrayStatus Names of face-centred FlowSolution_t fields (FaceCenter location) to load. Used only when DataLocation is "Face Data", which builds the mesh from faces and requires NGON_n element connectivity. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Families Names of CGNS families (Family_t nodes, such as a family grouping wall patches or a fluid region) whose zones and boundary patches are read. Zones or patches tagged with a family that is not selected are skipped; zones without a family are always read. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileNames The list of files to be read by the reader. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
IgnoreFlowSolutionPointers When checked, the reader will simply ignore FlowSolutionPointers in the CGNS file since they are either incomplete or invalid. To locate unsteady solution, the UseUnsteadyPattern option should then be activated. {"type":"boolean"} native initialisation / omitted false
IgnoreReaderTime When reading a file-series, if each file in the series does not provide correct time information, the reader will not be able to animate through the file series correctly. Check this to ignore the time information provided by each file. {"type":"boolean"} native initialisation / omitted false
LoadMesh Toggle whether zone mesh must be read for selected bases/families. {"type":"boolean"} native initialisation / omitted false
LoadPatches Toggle whether boundary condition patches must be read for selected bases/families. {"type":"boolean"} native initialisation / omitted false
PointArrayStatus Names of vertex-located FlowSolution_t fields (Vertex location) to load as point data on the zone blocks. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UnsteadySolutionStartTimestep Index assigned to the first time step when UseUnsteadyPattern matches FlowSolution_t nodes by the time-step index at the end of their names. Only used when UseUnsteadyPattern is true; the value must be 0 or more. {"type":"integer"} native initialisation / omitted 1
Use3DVector When true, vector fields of a 2-D solution (physical dimension 2) get a third component so they behave as 3-D vectors in filters such as glyphs or stream tracing; false keeps the solution's physical dimension (two components). It has no effect on 3-D cases. {"type":"boolean"} native initialisation / omitted false
UseUnsteadyPattern When true, the reader finds the FlowSolution_t node for each time step by name pattern (nodes whose names end in the time-step index) instead of relying on FlowSolutionPointers. Use it, usually together with IgnoreFlowSolutionPointers, for unsteady files whose pointers are missing or invalid; UnsteadySolutionStartTimestep sets the first index. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCGNSSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvCMLMoleculeReader#

Reads a Chemical Markup Language file (.cml, an XML description of atoms and bonds) into a vtkMolecule: atoms with element numbers and 3-D positions plus the bonds between them. vtkMolecule is not a mesh, so most dataset filters do not accept it; use pvMoleculeToLines to obtain polydata, or pvComputeMoleculeBonds to derive bonds. Use pvXYZReader or pvPDBReader for those formats.

Common mistakes and assumptions:

  • Coordinates are taken as written in the file (normally ångströms); nothing is converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: CMLMoleculeReader. Identity: sources/CMLMoleculeReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the CML file name Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCMLMoleculeReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvCONVERGECFDCGNSReader#

Reads CONVERGE CFD post-processing files written in CGNS (.cgns): the volume mesh, surfaces and parcels (Lagrangian spray or particle data stored in PARCEL_DATA UserDefinedData_t nodes) into a partitioned dataset collection with mesh and parcel datasets. Parcels become point clouds whose arrays are chosen in ParcelArrayStatus. Several files in FileNames form a time series. Use pvCONVERGECFDReader for CONVERGE HDF5 (.h5) post files and pvCGNSSeriesReader for general CGNS output.

Common mistakes and assumptions:

  • Mesh and parcel blocks have different arrays; extract the block you need (extractBlock) before filters that expect one dataset.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: CONVERGECFDCGNSReader. Identity: sources/CONVERGECFDCGNSReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Available cell variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileNames The list of files to read. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
ParcelArrayStatus Available parcel variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Available mesh point variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCONVERGECFDCGNSReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvCONVERGECFDReader#

Reads CONVERGE CFD HDF5 post files (.h5) into a partitioned dataset collection: each stream in the file is a top-level group holding its mesh (cell data), surfaces and parcels (point clouds of spray or particle data). The reader detects a time series from files named <prefix><zero-padded index>[_<time>].h5 next to the chosen file and takes each file's time from its metadata. Use pvCONVERGECFDCGNSReader for CONVERGE output written as CGNS.

Common mistakes and assumptions:

  • Name one file of the series; the other time steps are found by naming convention, so keep the files together and unrenamed.
  • The VTK reader does not support parallel loading.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: CONVERGECFDReader. Identity: sources/CONVERGECFDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Available cell variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The Converge CFD file name. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ParcelArrayStatus Available parcel variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCONVERGECFDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvCSVReader#

Reads delimited text (.csv, .tsv, .txt) into a table (vtkTable): one column per field, typed as numbers when DetectNumericColumns is on (ParaView default), with the first line as column names by default. The ParaView XML calls the output a 1-D rectilinear grid, but the underlying vtkDelimitedTextReader produces a table. Use pvTableToPoints or pvTableToStructuredGrid to turn coordinate columns into geometry; several files form a time series.

Common mistakes and assumptions:

  • The default delimiter is a comma only; set FieldDelimiterCharacters (or AddTabFieldDelimiter for tab-separated files) to match the file.
  • A table is not a dataset; filters that need points or cells reject it until it is converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: CSVReader. Identity: sources/CSVReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AddTabFieldDelimiter This property indicates whether to add the tab character as a field delimiter to the list of other delimiter characters. This is needed since in the GUI the user can't enter a tab character. {"type":"boolean"} native initialisation / omitted false
DetectNumericColumns When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray. {"type":"boolean"} native initialisation / omitted false
FieldDelimiterCharacters This property lists the characters that may be used to separate fields. For example, a value of "," indicates a comma-separated value file. A value of ".:;" indicates that columns may be separated by a period, colon or semicolon. The order of the characters in the text string does not matter. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileName The list of files to be read by the reader. Each file is expected to be a csv file. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
HaveHeaders If the value of this property is 1, treat the first line of the file as headers. {"type":"boolean"} native initialisation / omitted false
MergeConsecutiveDelimiters Whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many. {"type":"boolean"} native initialisation / omitted false
UseStringDelimiter This property indicates whether to use the string delimiter. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCSVReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvCalculator#

Full native Calculator: evaluates an expression over point, cell, row or other attribute arrays and stores the result as a new array of a chosen numeric type, or, with CoordinateResults, as new point coordinates (moving the mesh), or as normals or texture coordinates. Output has the input's data type. Use calculator for the common point/cell array case.

Common mistakes and assumptions:

  • AttributeType is the ParaView entry text ("Point Data", "Cell Data", "Row Data" for tables, …), the same texts the calculator operation uses; the expression may only use arrays of that association.
  • CoordinateResults needs a 3-component result; a scalar expression cannot move points.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Calculator. Identity: filters/Calculator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset (vtkDataSet, vtkTable or vtkGraph) to the Calculator filter. The scalar and vector variables may be chosen from this dataset's arrays. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); graphs (vertices and edges) (vtkGraph); tables (rows and columns) (vtkTable); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkGraph","vtkTable","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeType Data association the expression is evaluated on and the result is stored in; the same "Point Data" and "Cell Data" texts select the association in the calculator operation. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data" or "Row Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data"]} native initialisation / omitted "Point Data"
CoordinateResults The value of this property determines whether the results of this computation should be used as point coordinates or as a new array. {"type":"boolean"} native initialisation / omitted false
Function This property contains the equation for computing the new array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FunctionParserType Hidden ParaView switch selecting the expression parser: 1 uses the ExprTk-based parser introduced in ParaView 5.10 (vtkExprTkFunctionParser), 0 the older vtkFunctionParser of ParaView 5.9 and earlier, kept for old state files. Leave it unset unless an old expression only parses with the legacy parser. {"type":"integer"} native initialisation / omitted 1
ReplaceInvalidResults This property determines whether invalid values in the computation will be replaced with a specific value. (See the ReplacementValue property.) {"type":"boolean"} native initialisation / omitted false
ReplacementValue If invalid values in the computation are to be replaced with another value, this property contains that value. {"type":"number"} native initialisation / omitted 1
ResultArrayName This property contains the name for the output array containing the result of this computation. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ResultArrayType This property determines what array type to output. The default is a vtkDoubleArray. {"type":"enum","values":["Char","Signed Char","Unsigned Char","Short","Unsigned Short","Int","Unsigned Int","Long","Unsigned Long","Float","Double","Id Type"]} native initialisation / omitted "Char"
ResultNormals Set whether to output results as point/cell normals. Outputting as normals is only valid with vector results. Point or cell normals are selected using AttributeMode. {"type":"boolean"} native initialisation / omitted false
ResultTCoords Set whether to output results as point/cell texture coordinates. Point or cell texture coordinates are selected using AttributeMode. 2-component texture coordinates cannot be generated at this time. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCalculator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCellCenters#

Replaces each cell by a point at its parametric centre and outputs polygonal data; the input cell arrays become point arrays on those points. Use it to place glyphs or labels per cell, to probe or export cell-centred solver values as a point cloud, or as seeds. With VertexCells on, a vertex cell is added per point so the points render and count as cells. pvCoordinates instead keeps the mesh and adds centres as an array.

Common mistakes and assumptions:

  • The parametric centre is not the volume centroid for distorted or non-linear cells.
  • Without VertexCells (ParaView default false) the output has points but no cells, which some later operations and exports ignore.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CellCenters. Identity: filters/CellCenters. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Centers filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
VertexCells If set to 1, a vertex cell will be generated per point in the output. Otherwise only points will be generated. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCellCenters",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCellDatatoPointData#

Converts cell-centred arrays to point-centred arrays by averaging, at each point, the values of the cells that use it; the output has the same dataset type. Needed before operations that require point data, such as contouring, streamline tracing or smooth colouring of solver results stored per cell. It is the native filter behind cellToPoint, which keeps the cell data by Schemaxis default; pvCellDatatoPointData keeps ParaView's defaults, which convert all arrays and drop the original cell arrays.

Common mistakes and assumptions:

  • Averaging smooths discontinuities such as shocks or material interfaces; keep the cell data (PassCellData) when exact cell values matter.
  • With PieceInvariant false (default), values at partition boundaries can differ between MPI processes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CellDatatoPointData. Identity: filters/CellDataToPointData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Data to Point Data filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArraytoprocess Add a cell array by name to be converted to point array. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PassCellData If this property is set to 1, then the input cell data is passed through to the output; otherwise, only the generated point data will be available in the output. {"type":"boolean"} native initialisation / omitted false
PieceInvariant If the value of this property is set to 1, this filter will request ghost levels so that the values at boundary points match across processes. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces. {"type":"boolean"} native initialisation / omitted false
ProcessAllArrays The value of this property controls whether all input cell arrays will be processed and converted into point arrays. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCellDatatoPointData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCellGridElevation#

Adds a scalar attribute (default name Elevation) to a cell grid (vtkCellGrid) measuring distance from Origin: along Axis for Planar distance (ParaView default), from the line through Origin along Axis for Cylindrical distance, or from Origin itself for Spherical distance. Shock adds an offset that makes the field jump between cells, intended to demonstrate discontinuous Galerkin (DG) cells. Use it on cell-grid data from pvConvertToCellGrid or pvIOSSCellGridReader; for ordinary datasets use elevation or pvElevation.

Common mistakes and assumptions:

  • Input must be a vtkCellGrid; convert unstructured grids with pvConvertToCellGrid first.
  • Keep Shock at 0 for a continuous distance field; non-zero values deliberately create discontinuities at cell boundaries.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CellGridElevation. Identity: filters/ComputeCellGridElevation. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: An input cell-grid. Accepted data: cell grids (discontinuous Galerkin cells) (vtkCellGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCellGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeName The name of the output attribute added to the mesh. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Axis A non-zero vector. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
DistanceType Set how distance is measured. {"type":"enum","values":["Planar distance","Cylindrical distance","Spherical distance"]} native initialisation / omitted "Planar distance"
Origin A point in space. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Shock An offset to add to the elevation. Non-zero values create discontinuities. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCellGridElevation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCellGridProbe#

Probes a cell grid (Source port, vtkCellGrid) at the points of a polydata (Input port): the output polydata keeps the probe points that lie inside cells of the cell grid, with the chosen cell-grid attribute interpolated to them. A point inside several overlapping cells, typically on a shared boundary, appears once per cell. Use it to sample DG or other cell-grid fields along lines or at locations; for ordinary datasets use resample, pvResampleWithDataset or probeLine.

Common mistakes and assumptions:

  • Probe points outside the cell grid are dropped, so the output can have fewer points than the probe input.
  • Repeated points on cell boundaries bias averages; remove or account for them before summarizing.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CellGridProbe. Identity: filters/CellGridPointProbe. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: An input polydata to use as a probe. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: An input cell-grid to probe. Accepted data: cell grids (discontinuous Galerkin cells) (vtkCellGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCellGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellGridAttribute This property chooses a cell-grid attribute to sample. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCellGridProbe",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvCellSize#

Full native Cell Size filter: adds cell-data arrays with the point count of 0-D cells (VertexCount), the length of 1-D cells (Length), the area of 2-D cells (Area) and the volume of 3-D cells (Volume), in dataset coordinate units. Cells of other dimensions get 0 in each array. With ComputeSum the totals per array are also stored as one-value field-data arrays of the same names; for composite input the top-level output holds the sum over all blocks. Use it instead of cellSize when you need custom array names or to switch off the vertex count.

Common mistakes and assumptions:

  • Ghost cells receive per-cell values but are excluded from the sums.
  • Nothing is converted: a mesh in millimetres gives areas in square millimetres.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CellSize. Identity: filters/CellSize. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Size filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AreaArrayName Specify the name of the array to store 2D cell area and optionally the field data area sum. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ComputeArea Specify whether or not to compute the area of 2D cells. {"type":"boolean"} native initialisation / omitted false
ComputeLength Specify whether or not to compute the length of 1D cells. {"type":"boolean"} native initialisation / omitted false
ComputeSum Specify whether or not to sum the computed sizes of cells in datasets. The result is stored in field data. {"type":"boolean"} native initialisation / omitted false
ComputeVertexCount Specify whether or not to compute the number of points in 0D cells. {"type":"boolean"} native initialisation / omitted false
ComputeVolume Specify whether or not to compute the volume of 3D cells . {"type":"boolean"} native initialisation / omitted false
LengthArrayName Specify the name of the array to store the 1D cell length and optionally the field data length sum. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
VertexCountArrayName Specify the name of the array to store the 0D cell vertex count and optionally the field data vertex count sum. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
VolumeArrayName Specify the name of the array to store 3D cell volume and optionally the field data volume sum. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCellSize",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCesium3DTilesReader#

Reads a Cesium 3D Tiles tileset (the tileset .json file and the glTF, GLB or B3DM tiles it references) into a partitioned dataset collection with one partitioned dataset per tile. Coordinates stay in the tileset's Cartesian frame, typically Earth-centred metres for georeferenced city or terrain models. Use it to bring photogrammetry or city meshes into a pipeline; Level chooses how deep in the tile tree to read.

Common mistakes and assumptions:

  • ParaView 5.13.3 starts from Level 0, the root (coarsest) tiles; increase Level for more detail, at the cost of reading many more tiles.
  • Earth-centred coordinates are millions of metres from the origin; translate the data before combining it with local-coordinate models.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: Cesium3DTilesReader. Identity: sources/Cesium3DTiles Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Specify file name of the Cesium3DTiles tileset to read. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Level Level in the tree we read tiles from. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCesium3DTilesReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvCityGMLReader#

Reads a CityGML (.gml) city model into a multiblock dataset: top-level blocks per CityGML element type (buildings, roads, water bodies, vegetation …) labelled by an element field array, with polygonal leaves carrying a gml_id field array and, when textured, tcoords and a texture_uri. Only the chosen level of detail (LOD) is read. Use it for urban geometry, e.g. as obstacles for wind or dispersion studies.

Common mistakes and assumptions:

  • Objects that do not exist at the chosen LOD are missing from the output; lower LOD if buildings disappear.
  • Coordinates are in the file's coordinate reference system; nothing is reprojected.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: CityGMLReader. Identity: sources/CityGML Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BeginBuildingIndex Reads buildings between BeginBuildingIndex and EndBuildingIndex - 1 in the file. {"type":"integer"} native initialisation / omitted 1
EndBuildingIndex Reads buildings between BeginBuildingIndex and EndBuildingIndex - 1 in the file. {"type":"integer"} native initialisation / omitted 1
FileName Specify file name of the CityGML data file to read. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
LOD Specify the level of detail (LOD) to read. Valid values are from 0 (least detailed) through 4 (most detailed), default value is 3. {"maximum":4,"minimum":0,"type":"integer"} native initialisation / omitted 0
NumberOfBuildings Number of buildings to read from the file. {"type":"integer"} native initialisation / omitted 1
UseTransparencyAsOpacity Certain input files use app:transparency as opacity. Set this field true to show that correctly. The default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCityGMLReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvClean#

Cleans polygonal data: merges duplicate or nearby points, removes unused points and converts degenerate cells to lower-dimensional forms (a triangle with two merged points becomes a line, a zero-length line a point). Use it before operations that need connected topology, such as featureEdges, normals, pvDecimate or connectivity, on surfaces with duplicated vertices (STL, per-face exports). clean is the curated version; cleanGrid handles unstructured grids.

Common mistakes and assumptions:

  • With the default Tolerance 0 only exactly coincident points merge; a relative tolerance is a fraction of the bounding-box diagonal, so even 0.001 can merge real detail on a large model.
  • Input must be polydata; use cleanGrid or pvCleantoGrid for unstructured grids.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Clean. Identity: filters/CleanPolyData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Clean filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AbsoluteTolerance If merging nearby points (see PointMerging property) and using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging in the spatial units of the input data set. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ConvertLinesToPoints If this property is set to 1, degenerate lines (a "line" whose endpoints are at the same spatial location) will be converted to points. {"type":"boolean"} native initialisation / omitted false
ConvertPolysToLines If this property is set to 1, degenerate polygons (a "polygon" with only two distinct point coordinates) will be converted to lines. {"type":"boolean"} native initialisation / omitted false
ConvertStripsToPolys If this property is set to 1, degenerate triangle strips (a triangle "strip" containing only one triangle) will be converted to triangles. {"type":"boolean"} native initialisation / omitted false
PieceInvariant If this property is set to 1, the whole data set will be processed at once so that cleaning the data set always produces the same results. If it is set to 0, the data set can be processed one piece at a time, so it is not necessary for the entire data set to fit into memory; however the results are not guaranteed to be the same as they would be if the Piece invariant option was on. Setting this option to 0 may produce seams in the output dataset when ParaView is run in parallel. {"type":"boolean"} native initialisation / omitted false
PointMerging If this property is set to 1, then points will be merged if they are within the specified Tolerance or AbsoluteTolerance (see the Tolerance and AbsoluteTolerance properties), depending on the value of the ToleranceIsAbsolute property. (See the ToleranceIsAbsolute property.) If this property is set to 0, points will not be merged. {"type":"boolean"} native initialisation / omitted false
Tolerance If merging nearby points (see PointMerging property) and not using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging as a fraction of the length of the diagonal of the bounding box of the input data set. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ToleranceIsAbsolute This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvClean",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCleanCellstoGrid#

Removes duplicate cells (cells using the same set of points) from an unstructured grid and repairs cells that reference the same point more than once; the output is an unstructured grid. Use it after merging meshes or importing data with repeated elements. It assumes duplicate points were merged already, so run pvCleantoGrid first.

Common mistakes and assumptions:

  • Cells that are geometrically identical but use different (unmerged) point IDs are not detected as duplicates.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CleanCellstoGrid. Identity: filters/CleanUnstructuredGridCells. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Clean Cells to Grid filter. Accepted data: unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCleanCellstoGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCleantoGrid#

Merges coincident or nearly coincident points and converts any dataset to an unstructured grid, e.g. to join blocks that share faces or to feed an operation that needs unstructured input. Merging uses Tolerance (fraction of the bounding-box diagonal) or AbsoluteTolerance, and PointDataWeightingStrategy decides how data on merged points is combined. Use cleanGrid for the common case with Schemaxis defaults.

Common mistakes and assumptions:

  • Converting large structured grids to unstructured grids can use much more memory.
  • A tolerance that is too large fuses distinct points and collapses small cells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CleantoGrid. Identity: filters/CleanUnstructuredGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Clean to Grid filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AbsoluteTolerance When merging nearby points and using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging in the spatial units of the input data set. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
PointDataWeightingStrategy Select how to merge data located on merged points: - Take First Point (default): the point with the lowest index imposes its data on to the merged point - Average by Number: a number average is performed on all the duplicate points - Average by Spatial Density: an average by attached cell volume (i.e. for every cell the point is connected to sum cell_volume/number_cell_points) is performed on the point data {"type":"enum","values":["Take First Point","Average by Number","Average by Spatial Density"]} native initialisation / omitted "Take First Point"
RemovePointsWithoutCells When true, points that no cell uses are dropped from the output, together with their point data; when false they are kept as free points. Removing them gives a cleaner mesh for export, while keeping them preserves point counts and indices of point clouds. {"type":"boolean"} native initialisation / omitted false
Tolerance When merging nearby points and not using absolute tolerance (see ToleranceIsAbsolute property), this property specifies the tolerance for performing merging as a fraction of the length of the diagonal of the bounding box of the input data set. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ToleranceIsAbsolute This property determines whether to use absolute or relative (a percentage of the bounding box) tolerance when performing point merging. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCleantoGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvClientServerMoveData#

ParaView-internal helper that copies data from the server's root process to the client in a client-server session; without a remote connection it is a pass-through filter. Because the receiving side must create its output before data arrive, the output type is fixed by OutputDataType (and image extent by WholeExtent) rather than taken from the input. It has no analysis value in a Schemaxis pipeline; use passArrays or no filter at all.

Common mistakes and assumptions:

  • Keep OutputDataType equal to the input's VTK type id; the input is shallow-copied into an output of that type, so a mismatch gives incomplete or empty output.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ClientServerMoveData. Identity: filters/ClientServerMoveData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Client Server Move Data filter. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OutputDataType VTK data-object type id of the output, from vtkType.h: 0 polydata, 2 structured grid, 3 rectilinear grid, 4 unstructured grid, 6 image data. The filter creates an empty output of this type and copies the input into it, so it must match the input type. {"type":"integer"} native initialisation / omitted 1
WholeExtent Whole extent [xmin, xmax, ymin, ymax, zmin, zmax] (inclusive index bounds) announced for the output when the receiving process has no input of its own; it matters only for structured (image) outputs. With an input connected, the input's extent is used instead. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvClientServerMoveData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvClip#

Full native Clip: cuts the input with an implicit function chosen in ClipType (Plane, Box, Sphere, Cylinder) or with a scalar iso-value (ClipType Scalar plus Scalars and Value) and keeps one side, returning an unstructured grid. Crinkleclip keeps whole cells instead of cutting them. HyperTreeGridClipper replaces ClipType for hyper-tree-grid input. Use clip for a simple plane clip with Schemaxis defaults.

Common mistakes and assumptions:

  • ParaView starts with Invert true, which keeps the region inside the function (behind a plane's normal, inside a sphere or box); set Invert false to keep the other side.
  • With ClipType Scalar, point arrays are clipped exactly at Value, while cell arrays remove whole cells (threshold-like).
  • Schemaxis ships a Plane clip example (examples/schemaxis/paraview-catalogue.json), but the operation's coverage records no native qualification run; other clip types are unexercised.

Native constructor: Clip. Identity: filters/Clip. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset on which the Clip filter will operate. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType This property specifies the parameters of the clip function (an implicit description) used to clip the dataset. {"type":"typed proxy","choices":["Box","Cylinder","Plane","Scalar","Sphere"]} native initialisation / omitted {"type":"Box"}
Crinkleclip This parameter controls whether to extract entire cells in the given region or clip those cells so all of the output will stay only on that side of region. {"type":"boolean"} native initialisation / omitted false
Exact If this property is set to 1 it will clip to the exact specifications for the Box option only, otherwise the clip will only approximate the box geometry. The exact clip is very expensive as it requires generating 6 plane clips. Additionally, Invert must be checked and Crinkle clip must be unchecked. {"type":"boolean"} native initialisation / omitted false
HyperTreeGridClipper This property specifies the parameters of the clip function (an implicit description) used to clip the hyper tree grid. {"type":"typed proxy","choices":["Axis Aligned Box","Cylinder","Plane","Scalar","Sphere"]} native initialisation / omitted {"type":"Axis Aligned Box"}
Invert Invert which part of the geometry is clipped. {"type":"boolean"} native initialisation / omitted false
Scalars If clipping with scalars, this property specifies the name of the scalar array on which to perform the clip operation. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
UseValueAsOffset If UseValueAsOffset is true, Value is used as an offset parameter to the implicit function. Otherwise, Value is used only when clipping using a scalar array. {"type":"boolean"} native initialisation / omitted false
Value If clipping with scalars, this property sets the scalar value about which to clip the dataset based on the scalar array chosen. (See SelectInputScalars.) If clipping with a clip function, this property specifies an offset from the clip function to use in the clipping operation. Neither functionality is currently available in ParaView's user interface. {"type":"number"} native initialisation / omitted 1

Nested ClipType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: implicit_functions/Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Bounds Reference box [xmin, xmax, ymin, ymax, zmin, zmax] used only when UseReferenceBounds is true; the box is then these bounds scaled by Length, rotated by Rotation and translated by Position, all about the coordinate origin, so Length [1, 1, 1], Rotation [0, 0, 0] and Position [0, 0, 0] reproduce Bounds exactly. Ignored otherwise. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
ClipType.options.Length With UseReferenceBounds false: edge lengths [Lx, Ly, Lz] of the box along its own axes (ParaView applies them as scale factors to a unit cube). With UseReferenceBounds true: dimensionless scale factors applied to the Bounds box about the coordinate origin. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Position With UseReferenceBounds false: world coordinates [x, y, z] of the box’s minimum corner (before rotation); the box extends from Position to Position + Length along its own axes. With UseReferenceBounds true: a translation applied to the transformed Bounds box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Rotation Rotation angles [rx, ry, rz] about the x, y and z axes, applied about the box’s local origin (its minimum corner at Position, not its centre; with UseReferenceBounds true, about the coordinate origin). The angles are combined in VTK’s Z-X-Y convention: the box transform is Translate · RotateZ · RotateX · RotateY · Scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.UseReferenceBounds Chooses how the box is defined. False: the box is a unit cube scaled by Length, rotated about its corner and placed at Position. True: the box starts from Bounds, and Length, Rotation and Position act as scale, rotation and translation relative to it (about the coordinate origin). {"type":"boolean"} native initialisation / omitted false

Nested ClipType → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: implicit_functions/Cylinder. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Axis Direction [ax, ay, az] of the cylinder's axis line through Center; the cylinder is infinitely long in both directions. For ordinary datasets ParaView normalizes the vector, so only its direction matters. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Center Any point [x, y, z] on the cylinder’s axis line. Moving it along Axis changes nothing; moving it sideways moves the cylinder. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Radius Distance from the axis line to the cylinder surface; points closer than this are inside. {"type":"number"} native initialisation / omitted 1

Nested ClipType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
ClipType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested ClipType → Scalar#

Syntax: {"type":"Scalar","options":{...}}. Native identity: implicit_functions/Scalar. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested ClipType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Nested HyperTreeGridClipper → Axis Aligned Box#

Syntax: {"type":"Axis Aligned Box","options":{...}}. Native identity: implicit_functions/Axis Aligned Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridClipper.options.Bounds Native reference bounds [xmin, xmax, ymin, ymax, zmin, zmax]. The hyper-tree-grid clip computes its box from Position and Length, so Bounds does not affect the result. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
HyperTreeGridClipper.options.Length Edge lengths [Lx, Ly, Lz] of the clipping box; the far corner is Position + Length. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Position Minimum corner [x, y, z] of the clipping box; the box spans Position to Position + Length on each axis. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Rotation Native box orientation angles. The hyper-tree-grid clip that uses this choice builds its box from Position and Length only, so Rotation has no effect on the result. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.UseReferenceBounds Native switch that makes a ParaView box relative to Bounds. The hyper-tree-grid clip reads Position and Length directly, so this switch does not change its result. {"type":"boolean"} native initialisation / omitted false

Nested HyperTreeGridClipper → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: implicit_functions/Cylinder. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridClipper.options.Axis Direction [ax, ay, az] of the cylinder's axis line through Center; the cylinder is infinitely long in both directions. For ordinary datasets ParaView normalizes the vector, so only its direction matters. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Center Any point [x, y, z] on the cylinder’s axis line. Moving it along Axis changes nothing; moving it sideways moves the cylinder. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Radius Distance from the axis line to the cylinder surface; points closer than this are inside. {"type":"number"} native initialisation / omitted 1

Nested HyperTreeGridClipper → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridClipper.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
HyperTreeGridClipper.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested HyperTreeGridClipper → Scalar#

Syntax: {"type":"Scalar","options":{...}}. Native identity: implicit_functions/Scalar. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested HyperTreeGridClipper → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridClipper.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridClipper.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvClip",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvClipClosedSurface#

Clips a closed, manifold polygonal surface with a plane and caps the cut with new faces, so the result is again a closed (watertight) surface, e.g. to cut a CAD solid or an STL body and still compute its volume. Output is polydata; GenerateCellOrigins can add cell scalars that distinguish original faces from cap faces. Use clip or pvClip for volume meshes.

Common mistakes and assumptions:

  • The input must be closed and manifold (no open edges, no edges shared by more than two faces); otherwise caps are wrong or missing. Check with featureEdges first.
  • Face orientation defines the solid side: back faces must face the interior.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ClipClosedSurface. Identity: filters/ClipClosedSurface. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset on which the Clip filter will operate. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BaseColor Specify the color for the faces from the input. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipColor Specify the color for the capping faces (generated on the clipping interface). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClippingPlane This property specifies the parameters of the clipping plane used to clip the polygonal data. {"type":"typed proxy","choices":["Plane"]} native initialisation / omitted {"type":"Plane"}
ClippingTolerance Specify the tolerance for creating new points. A small value might incur degenerate triangles. {"type":"number"} native initialisation / omitted 1
GenerateCellOrigins Generate (cell) data for coloring purposes such that the newly generated cells (including capping faces and clipping outlines) can be distinguished from the input cells. {"type":"enum","values":["None","Color","Label"]} native initialisation / omitted "None"
GenerateFaces Generate polygonal faces in the output. {"type":"boolean"} native initialisation / omitted false
GenerateOutline Generate clipping outlines in the output wherever an input face is cut by the clipping plane. {"type":"boolean"} native initialisation / omitted false
InsideOut If this flag is turned off, the clipper will return the portion of the data that lies within the clipping plane. Otherwise, the clipper will return the portion of the data that lies outside the clipping plane. {"type":"boolean"} native initialisation / omitted false

Nested ClippingPlane → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClippingPlane.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClippingPlane.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
ClippingPlane.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvClipClosedSurface",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvColorByArray#

Converts one single-component point array of an image (vtkImageData) into colour values by passing it through a lookup table, producing image data whose scalars are unsigned char luminance, luminance-alpha, RGB (ParaView default) or RGBA tuples. Connect the LookupTable input to a lookup-table resource node such as pvResourcePVLookupTable; its value range and colours decide the mapping. Use it to bake a colour map into image data, e.g. before writing a PNG with pvWritePNGWriter; for on-screen colouring use scene appearance settings instead.

Common mistakes and assumptions:

  • Without a LookupTable the filter only passes the input through, which works only for unsigned char data already in the output format; always connect a lookup table.
  • The result holds colours, not the original values; keep the source image for quantitative work.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ColorByArray. Identity: filters/ColorByArray. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
LookupTable Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native LookupTable property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColorBy This property specifies the name of the scalar array from which we will color by. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
OutputFormat Number and meaning of the colour components written per pixel. RGB gives three 8-bit channels for ordinary colour images; RGBA adds the lookup table's opacity, for images that will be composited; Luminance and Luminance Alpha give a single grey channel (with or without alpha), which saves space but loses hue. {"type":"enum","values":["Luminance","Luminance Alpha","RGB","RGBA"]} native initialisation / omitted "Luminance"
RGBANaNColor Colour as [red, green, blue, alpha], each 0 to 255, written for points flagged invalid by the input's vtkValidPointMask array, such as points outside the source domain after resampling. It is not the colour for NaN values in the mapped array; those take the lookup table's own NaN colour. {"items":{"type":"integer"},"maxItems":4,"minItems":4,"type":"array"} native initialisation / omitted [1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvColorByArray",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCompositeCellGridReader#

Reads cell-grid data (.dg JSON files, e.g. discontinuous Galerkin or other high-order results) into a partitioned dataset collection of vtkCellGrid objects, keeping only the selected cell types and cell attributes. Cell grids store fields with their own interpolation rules rather than as ordinary point or cell arrays, so only filters that support vtkCellGrid accept the output directly. It is a distributed reader.

Common mistakes and assumptions:

  • Most classic filters (slice, contour, threshold) do not accept cell grids; check that each following operation supports them.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: CompositeCellGridReader. Identity: sources/CompositeCellGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellAttributes Select the cell attributes to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CellTypes Select the cell types to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The path to a file containing cell-grid JSON data. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCompositeCellGridReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvCompositeDataIDSelectionSource#

Creates an ID selection for composite data (multiblock or AMR): each entry names a block by flat index, a process (piece) and an element id within that block, interpreted as cell or point ids according to FieldType. Use it to pick specific cells or points in specific blocks, for example probe cells reported by an earlier run. For non-composite data use pvIDSelectionSource. A selection is not a dataset: connect it to the Selection input of pvExtractSelection, pvPlotSelectionOverTime or pvAnnotateSelection; it cannot be published as geometry.

Common mistakes and assumptions:

  • Element ids are local to the block and zero-based, not global ids; use pvGlobalIDSelectionSource for global ids.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CompositeDataIDSelectionSource. Identity: sources/CompositeDataIDSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
IDs The list of IDs that will be added to the selection produced by the selection source. This takes 3-tuple of values as (flat-index, process number, id). Complete tuples of 3 values. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCompositeDataIDSelectionSource"
}

pvComputeConnectedSurfaceProperties#

Deprecated alias of pvConnectedSurfaceProperties (ParaView 5.13 marks it for removal in 5.14); behaviour is identical. Computes the volume, surface area and centroid of each closed object in a polygonal input, plus totals; objects are found as connected components, or taken from an object-ID cell array. Per-object results go to field data (ObjectValidity, ObjectVolumes, ObjectAreas, ObjectCentroids) and per-polygon ObjectIds, Areas and Volumes to cell data. Use it to measure particles, droplets or parts in one surface mesh; use integrate for general integrals.

Common mistakes and assumptions:

  • Prefer pvConnectedSurfaceProperties; this name will disappear with the next ParaView release.
  • Objects must be closed and manifold for valid volumes; check the ObjectValidity array before trusting a value.
  • Volumes and areas are in dataset units cubed and squared; no unit conversion is applied.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ComputeConnectedSurfaceProperties. Identity: filters/ComputeConnectedSurfaceProperties. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ObjectIdsArrayName This property indicates the name of the array with the object IDs. The default name is "ObjectIds". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SkipObjectIdentification This property determines whether to skip the object identification which detects the multiple objects in the PolyData. This check can be skipped only if the PolyData has a CellData array with the object Ids, and the ids start with 0 index. The name of that array is configurable. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvComputeConnectedSurfaceProperties",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvComputeDerivatives#

Computes derivatives of point data at each cell's parametric centre and stores them as cell arrays: ScalarGradient (gradient of the selected point scalar) or Vorticity as the vector output, and VectorGradient (9-component tensor) or Strain as the tensor output. Input point and cell data pass through. Use it for cell-wise gradients of point fields on any mesh; use gradient or pvGradient for point-centred gradients and Q-criterion.

Common mistakes and assumptions:

  • The selected arrays must be point data; cell-centred solver fields give no derivatives, so convert them with cellToPoint first.
  • By ParaView default both a scalar gradient and a vector gradient are requested; set OutputVectorType or OutputTensorType to Nothing for what you do not need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ComputeDerivatives. Identity: filters/CellDerivatives. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OutputTensorType This property controls how the filter works to generate tensor cell data. You can choose to compute the gradient of the input vectors, or compute the strain tensor of the vector gradient tensor. By default, the filter will take the gradient of the vector data to construct a tensor. {"type":"enum","values":["Nothing","Vector Gradient","Strain"]} native initialisation / omitted "Nothing"
OutputVectorType This property controls how the filter works to generate vector cell data. You can choose to compute the gradient of the input scalars, or extract the vorticity of the computed vector gradient tensor. By default, the filter will take the gradient of the input scalar data. {"type":"enum","values":["Nothing","Scalar Gradient","Vorticity"]} native initialisation / omitted "Nothing"
Scalars This property indicates the name of the scalar array to differentiate. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
Vectors This property indicates the name of the vector array to differentiate. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvComputeDerivatives",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvComputeMoleculeBonds#

Adds single bonds to a molecule (vtkMolecule) from interatomic distances alone: two atoms are bonded when their distance is below the sum of their covalent radii widened by Tolerance. Valence, hybridization, aromaticity and bond order are ignored, so every bond is single. Use it when atoms come without connectivity, e.g. after pvConvertIntoMolecule or a coordinate-only reader, and follow with pvMoleculeToLines to turn the bonds into line cells.

Common mistakes and assumptions:

  • The covalent radii are VTK's periodic-table (Blue Obelisk) values in ångströms, so atom coordinates must be in ångströms; nanometre or bohr coordinates give missing or spurious bonds.
  • Every bond is single and inferred from distance alone; do not use the result for bond-order or valence analysis.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ComputeMoleculeBonds. Identity: filters/ComputeMoleculeBonds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: molecules (vtkMolecule). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMolecule"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
IsToleranceAbsolute This property determines if the tolerance is absolute (value is added to radius and should be positive) or not (value multiplied with radius and should be greater than 1). {"type":"boolean"} native initialisation / omitted false
Tolerance This property determines the tolerance to apply on covalent radius. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvComputeMoleculeBonds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvComputeQuartiles#

Computes, for every single-component numeric array, the five order statistics minimum, lower quartile, median, upper quartile and maximum, and outputs them as a table (vtkTable) with one column per array and five rows. For a dataset the point-data arrays are used; a table input uses its columns, and composite input adds one column per block (suffix Block<id>). Use it for box-plot style summaries of a field's distribution; use pvHistogram for the full distribution.

Common mistakes and assumptions:

  • Multi-component arrays such as velocity are skipped, not reduced to magnitude; compute a magnitude array first if you need its quartiles.
  • Cell-data arrays of a dataset are not summarised; convert them with cellToPoint or extract them to a table first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ComputeQuartiles. Identity: filters/ComputeQuartiles. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvComputeQuartiles",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvComputeSides#

Adds arrays to a cell grid (vtkCellGrid) listing the unshared sides of its cells, i.e. external surfaces and non-conforming internal interfaces, as (cell id, side id) pairs grouped by cell type and side shape. ParaView's cell-grid representation uses these arrays to render the grid efficiently; the cells themselves are unchanged. Use it when preparing cell grids from pvConvertToCellGrid for rendering or boundary extraction.

Common mistakes and assumptions:

  • The cell types must implement VTK's sides query; ordinary datasets need pvConvertToCellGrid first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ComputeSides. Identity: filters/ComputeCellGridSides. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: cell grids (discontinuous Galerkin cells) (vtkCellGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCellGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OmitSidesForRenderableInputs Set this property to true to avoid generating sides for input cells or sides that can be rendered as they are. If false, then sides will be output even for cells/sides that are surfaces or edges. As an example, if an input has hexahedra and triangle cells, this filter will generate quadrilateral sides (for the hexahedra) and edge sides (for the triangles) if OmitSidesForRenderableInputs is true, but only quadrilateral sides (for the hexahedra) if OmitSidesForRenderableInputs is false. Note that this is independent of whether some input cells are preserved or not. {"type":"boolean"} native initialisation / omitted false
PreserveRenderableInputs Set this property to true to include the original input cells in the output if they are of dimension 2 or lower (i.e., surface, edges, or vertices). If false, then only the computed sides will be output. As an example, if an input has hexahedra and triangle cells, this filter will output quadrilateral sides and triangle cells when PreserveRenderableInputs is true and only quadrilateral sides when PreserveRenderableInputs is false. {"type":"boolean"} native initialisation / omitted false
SidestoInclude Which sides are computed, by dimension. Next Lowest Dimension gives faces of volume cells, edges of surface cells and end points of edge cells; Surfaces of Inputs only faces of volume cells; Edges of Inputs the edges of volume and surface cells; Vertices of Inputs the corner points of all cells; All Sides every combination. {"type":"enum","values":["Surfaces of Inputs","Edges of Inputs","Vertices of Inputs","All Sides","Next Lowest Dimension"]} native initialisation / omitted "Surfaces of Inputs"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvComputeSides",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConduit#

In-situ source that converts a Conduit node following the Mesh Blueprint into a VTK dataset. The node is handed over in memory by a running simulation through Catalyst, not read from a file, so a Schemaxis document cannot supply its data. Use file readers for stored results.

Common mistakes and assumptions:

  • In a Schemaxis run nothing provides the Conduit node, so expect an empty or failing output.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Conduit. Identity: sources/Conduit. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConduit"
}

pvCone#

Creates a cone as polydata: a polygonal approximation with Resolution side facets, axis along Direction, height Height and base radius Radius, centred at Center (the midpoint of the axis), with the base capped by default. Use it as reference geometry or a glyph shape. The curated cone operation offers the same geometry with Schemaxis defaults and validated ranges.

Common mistakes and assumptions:

  • ParaView's default Resolution is 6, a visibly hexagonal cone; raise it (e.g. 32) for a round appearance.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Cone. Identity: sources/ConeSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Capping If this property is set to 1, the base of the cone will be capped with a filled polygon. Otherwise, the base of the cone will be open. {"type":"boolean"} native initialisation / omitted false
Center This property specifies the center of the cone. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Direction Set the orientation vector of the cone. The vector does not have to be normalized. The cone will point in the direction specified. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Height This property specifies the height of the cone. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Radius This property specifies the radius of the base of the cone. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Resolution This property indicates the number of divisions around the cone. The higher this number, the closer the polygonal approximation will come to representing a cone, and the more polygons it will contain. {"maximum":512,"minimum":0,"type":"integer"} native initialisation / omitted 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCone"
}

pvConnectedSurfaceProperties#

Computes the volume, surface area and centroid of each closed object in a polygonal input, plus totals; objects are found as connected components, or taken from an object-ID cell array. Per-object results go to field data (ObjectValidity, ObjectVolumes, ObjectAreas, ObjectCentroids) and per-polygon ObjectIds, Areas and Volumes to cell data. Use it to measure particles, droplets or parts in one surface mesh; use integrate for general integrals.

Common mistakes and assumptions:

  • Objects must be closed and manifold for valid volumes; check the ObjectValidity array before trusting a value.
  • Volumes and areas are in dataset units cubed and squared; no unit conversion is applied.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConnectedSurfaceProperties. Identity: filters/ConnectedSurfaceProperties. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ObjectIdsArrayName This property indicates the name of the array with the object IDs. The default name is "ObjectIds". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SkipObjectIdentification This property determines whether to skip the object identification which detects the multiple objects in the PolyData. This check can be skipped only if the PolyData has a CellData array with the object Ids, and the ids start with 0 index. The name of that array is configurable. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConnectedSurfaceProperties",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConnectivity#

Finds connected regions (cells linked through shared points) and outputs an unstructured grid of all regions, the largest one (most cells) or the one closest to ClosestPoint, per ExtractionMode. With ColorRegions (ParaView default true) RegionId arrays number the regions, in the order RegionIdAssignmentMode sets. Use it to separate disjoint parts, remove small fragments or isolate one body; connectivity is the curated version with fewer settings.

Common mistakes and assumptions:

  • Connectivity is topological: parts touching only through duplicate points count as separate regions; merge points with clean or cleanGrid first.
  • Largest region means most cells, not largest volume or area.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Connectivity. Identity: filters/PVConnectivityFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Connectivity filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ClosestPoint Specifies the point to use in closest point mode. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ColorRegions Controls the coloring of the connected regions. {"type":"boolean"} native initialisation / omitted false
ExtractionMode Controls the extraction of connected surfaces. {"type":"enum","values":["Extract Largest Region","Extract All Regions","Extract Closest Point Region"]} native initialisation / omitted "Extract Largest Region"
RegionIdAssignmentMode Specifies how regions IDs are assigned to the connected components. Unspecified means regions will have no particular order, Cell Count Descending assigns increasing region IDs to connected components with progressively smaller cell counts, and Cell Count Ascending assigns increasing region IDs to connected components with progressively larger cell counts. {"type":"enum","values":["Unspecified","Cell Count Descending","Cell Count Ascending"]} native initialisation / omitted "Unspecified"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConnectivity",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvContingencyStatistics#

Builds contingency tables (joint frequency counts) for pairs of the selected arrays, giving a bivariate probability model and the information entropy, and can assess each observation with joint and conditional probabilities and pointwise mutual information. It suits categorical or discrete variables such as material ids or flags. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.

Common mistakes and assumptions:

  • Select at least two arrays; continuous floating-point arrays produce one category per distinct value, so bin them first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ContingencyStatistics. Identity: filters/ContingencyStatistics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model. Accepted data: image data (uniform rectilinear grids) (vtkImageData); curvilinear structured grids (vtkStructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkStructuredGrid","vtkPolyData","vtkUnstructuredGrid","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
ModelInput Optional data input for the native ModelInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: A previously-calculated model with which to assess a separate dataset. This input is optional. Accepted data: tables (rows and columns) (vtkTable); multiblock datasets (vtkMultiBlockDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeMode Attribute association whose arrays are analysed; VariablesofInterest names are looked up in it. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
Task Specify the task to be performed: modeling and/or assessment. <ol> <li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li> <li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li> <li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li> <li> "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset. The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.</li> </ol> When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The <i>Training fraction</i> setting will be ignored for tasks 1 and 3. {"type":"enum","values":["Detailed model of input data","Model a subset of the data","Assess the data with a model","Model and assess the same data"]} native initialisation / omitted "Detailed model of input data"
TrainingFraction Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvContingencyStatistics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvContour#

Full native Contour: isosurfaces or isolines of a point scalar (cell scalar for hyper tree grids) at each value in Isosurfaces, output as polydata, with options for normals, gradients, contour-value scalars, triangle output, fast mode for image data, the 3-D strategy, point precision and point merging. Use contour for the common case with Schemaxis defaults.

Common mistakes and assumptions:

  • Isosurfaces has no default; with an empty list the output is empty.
  • For ordinary datasets the array must be point data; run cellToPoint on cell arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Contour. Identity: filters/Contour. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to be used by the contour filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point-centred array with 1 component (for vtkDataSet input). The input needs at least one cell-centred array with 1 component (for vtkHyperTreeGrid input). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeGradients If this property is set to 1, a scalar array containing a gradient value at each point in the isosurface or isoline will be created by this filter; otherwise an array of gradients will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0. Not that if ComputeNormals is set to 1, then gradients will have to be calculated, but they will only be stored in the output dataset if ComputeGradients is also set to 1. {"type":"boolean"} native initialisation / omitted false
ComputeNormals If this property is set to 1, a scalar array containing a normal value at each point in the isosurface or isoline will be created by the contour filter; otherwise an array of normals will not be computed. This operation is fairly expensive both in terms of computation time and memory required, so if the output dataset produced by the contour filter will be processed by filters that modify the dataset's topology or geometry, it may be wise to set the value of this property to 0. Select whether to compute normals. {"type":"boolean"} native initialisation / omitted false
ComputeScalars If this property is set to 1, an array of scalars (containing the contour value) will be added to the output dataset. If set to 0, the output will not contain this array. {"type":"boolean"} native initialisation / omitted false
ContourBy This property specifies the name of the scalar array from which the contour filter will compute isolines and/or isosurfaces. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
Contourstrategy3D Choose the contour strategy to apply (3D case only). IMPORTANT: the Use Decomposed Polyhedra strategy generally leads to better results but can take significantly more time to complete. {"type":"enum","values":["Use Voxels","Use Decomposed Polyhedra"]} native initialisation / omitted "Use Voxels"
FastMode This parameter controls whether to use Fast Mode or not. Fast Mode is only applicable to vtkImageData input and when GenerateTriangles is on. Fast Mode is much faster but it may produce degenerate triangles. {"type":"boolean"} native initialisation / omitted false
GenerateTriangles This parameter controls whether to produce triangles in the output. Warning: Many filters do not properly handle non-triangular polygons. {"type":"boolean"} native initialisation / omitted false
Isosurfaces This property specifies the values at which to compute isosurfaces/isolines and also the number of such values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
OutputPointsPrecision Select the output precision of the coordinates. Single sets the output to single-precision floating-point (i.e., float), Double sets it to double-precision floating-point (i.e., double), and Default sets it to the same precision as the precision of the points in the input. Defaults to Single. {"type":"enum","values":["Single","Double","Same as input"]} native initialisation / omitted "Single"
PointMergeMethod This property specifies which incremental point locator to use for handling duplicate/coincident points. {"type":"typed proxy","choices":["Not Merging Points","Octree Binning","Uniform Binning"]} native initialisation / omitted {"type":"Uniform Binning"}
ReduceOutputMemoryUsage If checked, the filter will optimize the space allocated to store the contour values. This option can lower the memory consumption, especially if the output contour contains a lot of points and is generated with few contour values, at the cost of some extra computation. Note that this option will do nothing if there are more than 256 contour values. {"type":"boolean"} native initialisation / omitted false

Nested PointMergeMethod → Not Merging Points#

Syntax: {"type":"Not Merging Points","options":{...}}. Native identity: incremental_point_locators/NonMergingPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Divisions Bucket counts along x, y and z inherited from the uniform point locator. Points are inserted without any duplicate search, so this has no effect on the output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PointMergeMethod.options.Numberofpointsperbucket Average bucket occupancy inherited from the uniform point locator; with direct insertion it has no effect on the output. {"type":"integer"} native initialisation / omitted 1

Nested PointMergeMethod → Octree Binning#

Syntax: {"type":"Octree Binning","options":{...}}. Native identity: incremental_point_locators/IncrementalOctreeMergePoints. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Maxnumberofpointsperleaf Maximum number of points an octree leaf holds before it is split into eight children. Smaller values build a deeper tree (more construction work, quicker searches inside each leaf); larger values do the opposite. Affects speed and memory only. {"maximum":256,"minimum":16,"type":"integer"} native initialisation / omitted 16
PointMergeMethod.options.Tolerance Distance within which a new point is treated as an existing one and merged. ParaView fixes it at 0 for this choice and hides it, as its XML instructs (always zero for merging); a positive value would also merge distinct points closer than this distance, altering the geometry. {"type":"number"} native initialisation / omitted 1

Nested PointMergeMethod → Uniform Binning#

Syntax: {"type":"Uniform Binning","options":{...}}. Native identity: incremental_point_locators/MergePoints. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Divisions Number of buckets along x, y and z of the uniform search grid used to find coincident points. It affects speed and memory only, never which points merge (only identical coordinates merge). VTK’s automatic sizing is on by default for this locator and ParaView does not expose it, so whenever the operation supplies an estimated point count the grid is sized from Number of points per bucket instead and Divisions is not used. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PointMergeMethod.options.Numberofpointsperbucket Target average number of points per bucket when the bucket grid is sized automatically (bucket count = estimated point count / this value). Smaller values create more, smaller buckets. Affects speed and memory only. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvContour",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertAMRdatasettoMultiblock#

Converts overlapping AMR data (vtkOverlappingAMR) into a multiblock dataset whose leaves are the individual uniform-grid blocks, so filters or writers that do not understand AMR can process them. The result is a flat multiblock with one block per AMR grid, listed level by level; grids are shallow copies, so their arrays (including any blanking array) are kept, but level and refinement metadata are lost and coarse cells covered by finer levels are not removed. Use pvResampleAMR instead when you need a single uniform grid.

Common mistakes and assumptions:

  • Overlapping levels mean the same region appears at several resolutions; integrals or statistics over all blocks count it more than once unless hidden cells are removed.
  • Non-overlapping AMR is not accepted by this filter.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertAMRdatasettoMultiblock. Identity: filters/AMRToMultiBlock. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input for this filter. Accepted data: overlapping AMR data (vtkOverlappingAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertAMRdatasettoMultiblock",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertIntoMolecule#

Turns a point set (polydata, unstructured grid or another vtkPointSet) into a molecule (vtkMolecule): every point becomes an atom at the same position, its element read from a one-component point array of atomic numbers, and the other point arrays become atom data. With ConvertLinesIntoBonds (ParaView default true) each line cell becomes a bond. Use it to bring particle or simulation output into the chemistry operations pvComputeMoleculeBonds, pvAppendMolecule and pvMoleculeToLines.

Common mistakes and assumptions:

  • The array must hold element numbers (1 hydrogen, 6 carbon, 8 oxygen…), not a simulation code's atom-type indices; remap types upstream, e.g. with calculator.
  • If no atomic-number array is selected and the input has no active point scalars, the native filter fails with "does not have atomic numbers as input".
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertIntoMolecule. Identity: filters/PointSetToMolecule. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AtomicNumbers This property indicates the name of the scalar array corresponding to atomic numbers. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ConvertLinesIntoBonds This property determines if the lines (cell of type VTK_LINE) are converted into bonds. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertIntoMolecule",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertPolyhedralCells#

Tries to convert polyhedron (and polygon) cells of an unstructured grid into equivalent simple cells (tetrahedron, pyramid, wedge, hexahedron) when their topology allows; cells that cannot be converted stay as they are. Output is an unstructured grid. Use it on meshes from polyhedral-capable readers such as OpenFOAM to speed up later processing and to allow operations that handle simple cells better.

Common mistakes and assumptions:

  • Genuinely polyhedral cells remain polyhedra; the output can still be mixed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertPolyhedralCells. Identity: filters/ConvertPolyhedra. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Convert Polyhedral Cells filter. Accepted data: unstructured grids (vtkUnstructuredGridBase). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGridBase"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertPolyhedralCells",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertSelection#

Converts a selection (a vtkSelection on the Input port, e.g. from pvIDSelectionSource or pvLocationSelectionSource) into another content type, evaluated against the dataset on DataInput: for example cell indices become the global IDs, or the values of a named array, at those cells. The output is again a vtkSelection with no geometry; feed it to pvExtractSelection or pvAnnotateSelection. vtkConvertSelection can produce INDICES, GLOBALIDs, PEDIGREEIDS or VALUES from another type; FRUSTUM, LOCATIONS and THRESHOLDS are only accepted when the input selection already has that type.

Common mistakes and assumptions:

  • ParaView 5.13.3 initializes OutputType to LOCATIONS, which cannot be produced from any other selection type; always set OutputType, usually to INDICES, GLOBALIDs or VALUES.
  • VALUES output needs at least one name in ArrayNames and THRESHOLDS exactly one; otherwise the native filter reports an error.
  • GLOBALIDs and PEDIGREEIDS output read the designated global-ID or pedigree-ID array of the DataInput dataset; datasets without one cannot be converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertSelection. Identity: filters/ConvertSelection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
DataInput Required data input for the native DataInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the vtkDataObject input used to convert the selection. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the selection to convert. Accepted data: selections (vtkSelection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AllowMissingArray When true, an array the conversion needs but cannot find on DataInput (the array of a value or threshold input selection, or the pedigree-ID array for PEDIGREEIDS output) no longer makes the filter fail; it returns without error, possibly with an empty or partial selection. When false the native filter reports an error instead. {"type":"boolean"} native initialisation / omitted false
ArrayNames Names of DataInput arrays whose values at the selected elements form the new selection: one or more names for VALUES output, exactly one for THRESHOLDS. The arrays are looked up in the cell data, or in the point data when the input selection is point-based. Ignored for INDICES, GLOBALIDs and PEDIGREEIDS output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MatchAnyValues When true, each array in ArrayNames becomes its own selection node, so an element is selected when it matches the values of any one array (nodes are combined by union). When false, all arrays are stored in a single node. {"type":"boolean"} native initialisation / omitted false
OutputType Set the ContentType for the output. {"type":"enum","values":["GLOBALIDs","PEDIGREEIDS","VALUES","INDICES","FRUSTUM","LOCATIONS","THRESHOLDS"]} native initialisation / omitted "GLOBALIDs"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertSelection",
  "inputs": {
    "DataInput": "UPSTREAM_DataInput",
    "Input": "UPSTREAM_Input"
  }
}

pvConvertToCellGrid#

Converts an unstructured grid, or a composite whose leaves are unstructured grids with linear cells, into a partitioned dataset collection of cell grids (vtkCellGrid). Field-data annotations written by the IOSS reader promote certain cell arrays to spatially varying discontinuous Galerkin (DG) attributes; data without annotations is converted too. Use it before pvComputeSides, pvCellGridElevation or pvCellGridProbe.

Common mistakes and assumptions:

  • VTK assumes all cells of one shape in a grid have the same order; mixed-order meshes may convert incorrectly.
  • A cell grid is not a vtkDataSet, so dataset operations cannot take this output; keep the original branch for ordinary processing.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertToCellGrid. Identity: filters/ConvertToCellGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: unstructured grids (vtkUnstructuredGrid); data-object trees (multiblock or partitioned) (vtkDataObjectTree); unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid","vtkDataObjectTree","vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertToCellGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertToMultiBlock#

Wraps any input — a single dataset, table, graph or composite — in a vtkMultiBlockDataSet: a non-composite input becomes one block, other composites keep their hierarchy, and a multiblock passes through. Use it when a later step or writer expects multiblock data, e.g. pvWriteXMLMultiBlockDataWriter; pvConvertToPartitionedDataSetCollection produces the newer partitioned format.

Common mistakes and assumptions:

  • Wrapping adds structure, not data; steps that need a single dataset then require merge or extractBlock.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertToMultiBlock. Identity: filters/ConvertToMultiBlock. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertToMultiBlock",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertToPartitionedDataSetCollection#

Converts any input to a vtkPartitionedDataSetCollection. Multiblock and AMR inputs get a data assembly that reproduces their hierarchy, so blocks can still be chosen by path with extractBlock or pvExtractBlock. Use it for steps or writers that require partitioned collections, such as pvWriteXMLPartitionedDataSetCollectionWriter; pvConvertToMultiBlock produces the older multiblock format.

Common mistakes and assumptions:

  • A single dataset becomes a one-partition collection; use merge to get a plain dataset back.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertToPartitionedDataSetCollection. Identity: filters/ConvertToPartitionedDataSetCollection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertToPartitionedDataSetCollection",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvConvertToPointCloud#

Converts any dataset into polydata that keeps only the input points and their point-data arrays; cells and cell data are dropped. CellGenerationMode decides whether the result has one vertex cell per point (ParaView default), a single polyvertex cell, or no cells at all. Use it to treat mesh nodes or particles as a point cloud, e.g. before pvPCANormalEstimation or point-based interpolation.

Common mistakes and assumptions:

  • Cell-centred fields are lost; run cellToPoint first if they are needed on the points.
  • With No cells, many filters and renderers see nothing to draw; keep vertex cells unless a later step needs cell-free points.
  • On large image or structured inputs the explicit point list can need much more memory than the original grid.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ConvertToPointCloud. Identity: filters/ConvertToPointCloud. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the ConvertToPointCloud filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellGenerationMode Choose if the output should contain either no cells (output may not appear in a render view in that case), a single poly vertex cell and as many vertex cells as there is points. {"type":"enum","values":["No cells","Polyvertex cell","Vertex cells"]} native initialisation / omitted "No cells"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvConvertToPointCloud",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCoordinates#

Adds point coordinates and cell centres as data arrays: PointLocations (3-component point array, a copy of each point's coordinates) and CellCenters (3-component cell array). Geometry and existing arrays are unchanged. Use it when a calculator, export or table needs coordinates as ordinary arrays, e.g. to compute a radius or write x, y, z to CSV. pvCellCenters instead produces points at the cell centres.

Common mistakes and assumptions:

  • Cell centres are parametric centres, which can differ from centroids for distorted cells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Coordinates. Identity: filters/Coordinates. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Append Location Attributes filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AppendCellCenters Adds a cell data array named CellCenters that is stores the centers of cells in the input. {"type":"boolean"} native initialisation / omitted false
AppendPointLocations Adds a point data array named PointLocations that is a copy of the point locations in the input. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCoordinates",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCosmoReader#

Reads binary cosmology particle files in LANL cosmo format (.cosmo, .cosmo64) or Gadget-2 format (vtkPCosmoReader) into an unstructured grid of particles with point arrays velocity, mass, tag and ghost. Several file names form a time series, one file per time step. Its output is the expected input of pvLANLFOFSODHaloFinder. Use pvGenericIOReader for HACC GenericIO output.

Common mistakes and assumptions:

  • Set CosmoFormat to match the file; ParaView starts from Cosmo, and Gadget files read as cosmo give garbage.
  • Particles outside [0, BoxSideLength) are wrapped periodically, so set the box size of the run.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CosmoReader. Identity: sources/CosmoReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoxSideLength The box side length is used to wrap particles around if they exceed rL (or less than 0) in any dimension. {"type":"number"} native initialisation / omitted 1
CosmoFormat If checked, the data will be read as the LANL Cosmo format. If unchecked, the data will be read as Gadget-2 format. {"type":"enum","values":["Gadget","Cosmo"]} native initialisation / omitted "Gadget"
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Overlap The space (in rL units) to extend processor particle ownership for ghost particles/cells. It is needed for correct halo calculation when halos cross processor boundaries in parallel computation. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCosmoReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvCountCellFaces#

Adds a cell array (default name "Face Count") with the number of faces of each cell, as reported by VTK: 6 for a hexahedron, 4 for a tetrahedron, the face count of a polyhedron, and 0 for 2-D and lower cells, whose edges are not faces. Use it to inspect polyhedral meshes, e.g. from snappyHexMesh, or to threshold cells by face count.

Common mistakes and assumptions:

  • Surface meshes give 0 everywhere; use pvCountCellVertices for polygons.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CountCellFaces. Identity: filters/CountCellFaces. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FacesArrayName This is the name of the array in the output containing the face counts. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCountCellFaces",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCountCellVertices#

Adds a cell array (default name "Vertex Count") with the number of points of each cell, e.g. 3 for triangles, 8 for hexahedra and the point count of polygons and polyhedra. Use it to check mixed meshes or threshold cells by type-like size.

Common mistakes and assumptions:

  • Higher-order cells count their mid-edge nodes too (e.g. 10 for a quadratic tetrahedron).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CountCellVertices. Identity: filters/CountCellVertices. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
VerticesArrayName This is the name of the array in the output containing the vertex counts. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCountCellVertices",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCriticalTime#

Scans every time step of a temporal input and records, for each point or cell, the first time value at which the selected array meets a threshold criterion (above, below or between thresholds; comparisons include the threshold values). The result is a static (non-temporal) dataset with one array named <array>_critical_time; other point and cell arrays are dropped, and entries whose criterion is never met are NaN. Use it for arrival or exceedance maps, e.g. when temperature first exceeds a limit. The mesh must keep the same points and cells over time.

Common mistakes and assumptions:

  • The filter executes the whole upstream pipeline for every stored time step, which can be slow for long series.
  • With the ParaView defaults (Above Upper Threshold, UpperThreshold 0) any non-negative value counts as met, so most entries become the first time; always set the threshold.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: CriticalTime. Identity: filters/CriticalTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Critical Time filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComponentMode This property specifies how multi-component arrays are handled. 'Selected' will use the 'Selected Component' property. 'All' will pass if all components satisfy the threshold criterion. 'Any' will pass if any component satisfies the threshold criterion. {"type":"enum","values":["Selected","All","Any"]} native initialisation / omitted "Selected"
LowerThreshold This value specifies the lower threshold. {"type":"number"} native initialisation / omitted 1
Scalars The value of this property contains the name of the array from which to generate the critical time values. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
SelectedComponent This property specifies which component of the array needs to satisfy the threshold criterion. {"type":"integer"} native initialisation / omitted 1
ThresholdCriterion This property indicates the threshold criterion used to generate the critical time values. {"type":"enum","values":["Between","Below Lower Threshold","Above Upper Threshold"]} native initialisation / omitted "Between"
UpperThreshold This value specifies the upper threshold. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCriticalTime",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCrop#

Extracts a sub-block of an image or volume (vtkImageData) given as a point-index extent [imin, imax, jmin, jmax, kmin, kmax]; the output keeps the input origin and spacing, so cropped points stay at their original positions. Use it to cut a region of interest from a large image before costly filtering or export. To cut by world coordinates or with an arbitrary shape use clip; extractSubset selects an index range with sampling rates as well.

Common mistakes and assumptions:

  • Indices are point indices of the input's extent, not coordinates; convert positions with (x − origin) / spacing.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Crop. Identity: filters/ImageClip. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Crop filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OutputWholeExtent This property gives the minimum and maximum point index (extent) in each dimension for the output dataset. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCrop",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCurvature#

Generated binding of ParaView's Curvature filter: computes per-point Gaussian (ParaView default) or mean curvature of a polygonal surface into the point array Gauss_Curvature or Mean_Curvature. Gaussian curvature is positive on sphere-like and negative on saddle-like regions (units 1/length²); mean curvature (1/length) assumes outward normals. Use the curated curvature (Schemaxis default Mean) for the usual case; this binding defaults to Gaussian.

Common mistakes and assumptions:

  • Volume meshes are rejected; extract the surface first (surface or pvExtractSurface).
  • Results are noisy on coarse or poorly shaped triangulations; smooth or refine first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Curvature. Identity: filters/Curvatures. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Curvature filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CurvatureType This property specifies which type of curvature to compute. {"type":"enum","values":["Gaussian","Mean"]} native initialisation / omitted "Gaussian"
InvertMeanCurvature If this property is set to 1, the mean curvature calculation will be inverted. This is useful for meshes with inward-pointing normals. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCurvature",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvCylinder#

Creates a cylinder as polydata with normals and texture coordinates: Resolution side facets, axis parallel to y, centred at Center, with both ends capped by default. Use it as reference geometry, e.g. a pipe or probe region. The orientation is fixed to y; rotate it with transform for other axes.

Common mistakes and assumptions:

  • The axis is always y in this source; Center moves it but cannot tilt it.
  • ParaView's default Resolution is 6; raise it for a round cross-section.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Cylinder. Identity: sources/CylinderSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Capping If this property is set to 1, the ends of the cylinder will each be capped with a closed polygon. Otherwise, the ends of the cylinder will be open. {"type":"boolean"} native initialisation / omitted false
Center This property specifies the coordinate value at the center of the cylinder. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Height This property specifies the height of the cylinder (along the y axis). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Radius This property specifies the radius of the cylinder. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Resolution This property indicates the number of divisions around the cylinder. The higher this number, the closer the polygonal approximation will come to representing a cylinder, and the more polygons it will contain. {"maximum":512,"minimum":2,"type":"integer"} native initialisation / omitted 2

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvCylinder"
}

pvD3#

Parallel repartitioning (distributed data decomposition): builds a k-d tree over the distributed dataset and redistributes cells so each MPI process owns a spatially contiguous, load-balanced region, optionally with ghost-cell layers; output is an unstructured grid. In a serial run it acts almost as a pass-through, but non-composite input is still converted to an unstructured grid. pvRedistributeDataSet is the newer alternative with more output control.

Common mistakes and assumptions:

  • Image, rectilinear and structured grids become explicit unstructured grids, which can need much more memory; ParaView warns about this.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: D3. Identity: filters/D3. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the D3 filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundaryMode This property determines how cells that lie on processor boundaries are handled. The "Assign cells uniquely" option assigns each boundary cell to exactly one process, which is useful for isosurfacing. Selecting "Duplicate cells" causes the cells on the boundaries to be copied to each process that shares that boundary. The "Divide cells" option breaks cells across process boundary lines so that pieces of the cell lie in different processes. This option is useful for volume rendering. {"type":"enum","values":["Assign cells uniquely","Duplicate cells","Divide cells"]} native initialisation / omitted "Assign cells uniquely"
MinimalMemory If this property is set to 1, the D3 filter requires communication routines to use minimal memory than without this restriction. {"type":"boolean"} native initialisation / omitted false
MinimumNumberOfGhostLevels The minimum number of ghost levels to add to each processor's output. If the pipeline also requests ghost levels, the larger value will be used. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvD3",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDEMReader#

Reads a USGS Digital Elevation Model (.dem, the ASCII DEM format) into 2-D uniform image data whose point scalars are elevations; origin and spacing come from the DEM header. Use pvWarpByScalar or warpScalar to turn it into a 3-D terrain surface.

Common mistakes and assumptions:

  • DEM headers can use different units for elevation and ground distance (for example metres versus arc-seconds); check them before warping or combining with other data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DEMReader. Identity: sources/DEMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the DEM (Digital Elevation Map) reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDEMReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvDICOMReaderSingleFile#

Reads one uncompressed DICOM file (.dcm) into uniform image data with the pixel values as point scalars and the pixel spacing from the header. Use it for a single slice; for a series stored as one slice per file use pvDICOMReaderdirectory.

Common mistakes and assumptions:

  • vtkDICOMImageReader handles neither compressed (encapsulated) transfer syntaxes nor multi-frame files; convert such data first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DICOMReaderSingleFile. Identity: sources/DICOMReaderSingle. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName DICOM file to load. This version of the reader only supports loading one file at a time. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDICOMReaderSingleFile",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvDICOMReaderdirectory#

Reads every DICOM file in one directory as the slices of a single 3-D image volume (uniform image data), the usual layout of CT and MR series. In Schemaxis, FileName must be the directory itself: the value goes straight to vtkDICOMImageReader's SetDirectoryName. Use pvDICOMReaderSingleFile for one file.

Common mistakes and assumptions:

  • Slice spacing comes from Slice Thickness (0018,0050), which is right only for contiguous slices; check the z spacing for gapped or overlapping acquisitions.
  • Keep one series per directory; every valid DICOM file in it becomes part of the volume. Only uncompressed files are read.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DICOMReaderdirectory. Identity: sources/DICOMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Path of the directory containing the DICOM slice files. The value is passed directly to vtkDICOMImageReader's SetDirectoryName, which opens it as a folder and reads every valid DICOM file inside as one volume. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder; absolute paths avoid ambiguity. The value is a constructor option, so it must be a constant. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDICOMReaderdirectory",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvDataObjectGenerator#

Builds small test datasets from a text Program: atomic templates ID1 (image data), UF1 (uniform grid), RG1 (rectilinear), SG1 (structured), PD1/PD2 (polydata) and UG1 (unstructured grid), nested in composites with MB{ … } (multiblock) or HB[ … ] (hierarchical box AMR, levels in parentheses). For example "MB{ ID1 PD1 MB{} }" gives a multiblock of an image, a polydata and an empty block. Use it to exercise how a pipeline handles particular data types and composite structures.

Common mistakes and assumptions:

  • The generated datasets are tiny templates with id arrays, not physically meaningful fields.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: DataObjectGenerator. Identity: sources/DataObjectGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Program This property contains the string that is parsed to determine the structured of the output data object to produce. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDataObjectGenerator"
}

pvDateToNumeric#

Finds string arrays holding dates (point, cell, field or table row data) and adds a numeric copy of each as <name>_numeric, in seconds since the Unix epoch, so dates can be plotted, thresholded or used in calculators. VTK tries DateFormat first, then built-in fallback formats; the format is chosen from the first value, and an array whose first value does not parse is skipped. Typical input is a CSV table read with a CSV reader.

Common mistakes and assumptions:

  • Dates are interpreted in the local time zone of the machine running ParaView (std::mktime), so results shift between machines; store UTC times and compare on one machine.
  • Values that do not match the chosen format become 0.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DateToNumeric. Identity: filters/DateToNumeric. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DateFormat This property specifies the first format to try using to parse dates. It follows the standards of std::get_time. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDateToNumeric",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDecimate#

Reduces the triangle count of a triangle surface with vtkDecimatePro, removing vertices in order of least error until TargetReduction (ParaView default 0.9, about 90 % of triangles removed) is reached. By ParaView default PreserveTopology is off, so the surface may be split along feature edges (FeatureAngle 15°) and holes may open to reach the target. Input must be triangles; run triangulate first. decimate is the curated version (Schemaxis defaults 0.5, topology preserved); pvQuadricClustering is faster on very large meshes.

Common mistakes and assumptions:

  • The native defaults remove 90 % of triangles and allow holes; set PreserveTopology true and a smaller TargetReduction when the surface must stay closed.
  • Only triangles are processed; triangulate general polygons first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Decimate. Identity: filters/DecimatePro. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Decimate filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundaryVertexDeletion If this property is set to 1, then vertices on the boundary of the dataset can be removed. Setting the value of this property to 0 preserves the boundary of the dataset, but it may cause the filter not to reach its reduction target. {"type":"boolean"} native initialisation / omitted false
FeatureAngle The value of this property is used in determining where the data set may be split. If the angle between two adjacent triangles is greater than or equal to the FeatureAngle value, then their boundary is considered a feature edge where the dataset can be split. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
PreserveTopology If this property is set to 1, decimation will not split the dataset or produce holes, but it may keep the filter from reaching the reduction target. If it is set to 0, better reduction can occur (reaching the reduction target), but holes in the model may be produced. {"type":"boolean"} native initialisation / omitted false
TargetReduction This property specifies the desired reduction in the total number of polygons in the output dataset. For example, if the TargetReduction value is 0.9, the Decimate filter will attempt to produce an output dataset that is 10% the size of the input.) {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDecimate",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDecimatePolyline#

Reduces the points of polylines by repeatedly deleting the interior vertex with the smallest error until TargetReduction (ParaView default 0.9) of the segments is removed or the next deletion would exceed MaximumError. The error comes from DecimationStrategy: distance of a vertex from the line through its neighbours (Decimation Distance Strategy, default), the angle at the vertex, or a custom point array. End points are kept, but closed loops can collapse to one segment. Use it to simplify streamlines, contours or GIS polylines.

Common mistakes and assumptions:

  • Separate two-point line cells have no interior vertices; join them into polylines first with pvTriangleStrips and JoinContiguousSegments.
  • Vertices shared by several polylines are treated independently, which can break junctions.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DecimatePolyline. Identity: filters/DecimatePolyline. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Decimate Polyline filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DecimationStrategy This property determines which decimation strategy to use for the poly line decimation. {"type":"typed proxy","choices":["Decimation Angle Strategy","Decimation Custom Field Strategy","Decimation Distance Strategy"]} native initialisation / omitted {"type":"Decimation Angle Strategy"}
MaximumError Set the largest decimation error that is allowed during the decimation process. This may limit the maximum reduction that may be achieved. The maximum error is specified as a fraction of the maximum length of the input data bounding box. {"type":"number"} native initialisation / omitted 1
TargetReduction This property specifies the desired reduction in the total number of lines in the output dataset. For example, if the TargetReduction value is 0.9, the Decimate Polyline filter will attempt to produce an output dataset that is 10% the size of the input. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested DecimationStrategy → Decimation Angle Strategy#

Syntax: {"type":"Decimation Angle Strategy","options":{...}}. Native identity: polyline_decimation_strategies/DecimationAngleStrategy. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested DecimationStrategy → Decimation Custom Field Strategy#

Syntax: {"type":"Decimation Custom Field Strategy","options":{...}}. Native identity: polyline_decimation_strategies/DecimationCustomFieldStrategy. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
DecimationStrategy.options.FieldName Name of the point-data array on the input polylines whose values measure each vertex's error; arrays with any number of components are accepted. If no point array of that name exists, the filter warns that the strategy is not in a valid state and returns an empty output (no points or lines). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested DecimationStrategy → Decimation Distance Strategy#

Syntax: {"type":"Decimation Distance Strategy","options":{...}}. Native identity: polyline_decimation_strategies/DecimationDistanceStrategy. Omitted nested options retain native values on subsequent visits.

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDecimatePolyline",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDeflectNormals#

Tilts surface normals by a vector field: each new normal is normalize(N + ScaleFactor × V), where N is the input point normal (or the constant UserNormal) and V the selected point vector. The result is a point normal array DeflectedNormals set as the active normals; geometry is unchanged. It is a shading effect for visualizing a vector field on a surface (e.g. bump-like lighting from velocity), not a physical quantity.

Common mistakes and assumptions:

  • Without input point normals ParaView warns and falls back to UserNormal; compute normals first (normals or pvGenerateSurfaceNormals) for curved surfaces.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DeflectNormals. Identity: filters/DeflectNormals. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ScaleFactor Normal deflection factor. {"type":"number"} native initialisation / omitted 1
UseUserNormal Use a user specified normal instead of the existing point normals. {"type":"boolean"} native initialisation / omitted false
UserNormal Specify the user constant normal. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Vectors The value of this property contains the name of the vector array by which to deflect the dataset's normals. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDeflectNormals",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDelaunay2D#

Full native Delaunay 2D: triangulates input points (vtkPointSet) into polydata triangles. Beyond delaunay2D it exposes ProjectionPlaneMode — XY Plane (default) ignores z, Best-Fitting Plane projects the points onto their least-squares plane first so tilted, nearly planar sets triangulate correctly — and Offset and BoundingTriangulation, which control the initial bounding triangulation. Alpha and Tolerance act as in delaunay2D (ParaView defaults 0 and 0.00001).

Common mistakes and assumptions:

  • Best-Fitting Plane suits roughly planar data only; strongly curved point sets still fold.
  • BoundingTriangulation true adds the artificial bounding points and triangles to the output; it is a debugging aid.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Delaunay2D. Identity: filters/Delaunay2D. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the Delaunay 2D filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Alpha The value of this property controls the output of this filter. For a non-zero alpha value, only edges or triangles contained within a sphere centered at mesh vertices will be output. Otherwise, only triangles will be output. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
BoundingTriangulation If this property is set to 1, bounding triangulation points (and associated triangles) are included in the output. These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output. {"type":"boolean"} native initialisation / omitted false
Offset This property is a multiplier to control the size of the initial, bounding Delaunay triangulation. {"minimum":0.75,"type":"number"} native initialisation / omitted 0.75
ProjectionPlaneMode This property determines type of projection plane to use in performing the triangulation. {"type":"enum","values":["XY Plane","Best-Fitting Plane"]} native initialisation / omitted "XY Plane"
Tolerance This property specifies a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDelaunay2D",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDelaunay3D#

Full native Delaunay 3D: tetrahedralizes input points (vtkPointSet) into an unstructured grid. Beyond delaunay3D it exposes which alpha-shape cell types are output when Alpha > 0 (AlphaTets and AlphaTris on, AlphaLines and AlphaVerts off by ParaView default), the Offset of the initial bounding tetrahedralization (default 2.5) and BoundingTriangulation. Alpha and Tolerance act as in delaunay3D (ParaView defaults 0 and 0.001).

Common mistakes and assumptions:

  • A larger Offset makes a true convex hull more likely but increases the risk of numerical problems.
  • Delaunay 3D can exhaust memory on large point sets; thin or clean the points first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Delaunay3D. Identity: filters/Delaunay3D. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the Delaunay 3D filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Alpha This property specifies the alpha (or distance) value to control the output of this filter. For a non-zero alpha value, only edges, faces, or tetra contained within the circumsphere (of radius alpha) will be output. Otherwise, only tetrahedra will be output. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
AlphaLines This boolean controls whether lines which satisfy the alpha criterion output when alpha is non-zero. {"type":"boolean"} native initialisation / omitted false
AlphaTets This boolean controls whether tetrahedrons which satisfy the alpha criterion output when alpha is non-zero. {"type":"boolean"} native initialisation / omitted false
AlphaTris This boolean controls whether triangles which satisfy the alpha criterion output when alpha is non-zero. {"type":"boolean"} native initialisation / omitted false
AlphaVerts This boolean controls whether vertices which satisfy the alpha criterion are output when alpha is non-zero. {"type":"boolean"} native initialisation / omitted false
BoundingTriangulation This boolean controls whether bounding triangulation points (and associated triangles) are included in the output. (These are introduced as an initial triangulation to begin the triangulation process. This feature is nice for debugging output.) {"type":"boolean"} native initialisation / omitted false
Offset This property specifies a multiplier to control the size of the initial, bounding Delaunay triangulation. {"minimum":2.5,"type":"number"} native initialisation / omitted 2.5
Tolerance This property specifies a tolerance to control discarding of closely spaced points. This tolerance is specified as a fraction of the diagonal length of the bounding box of the points. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDelaunay3D",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDescriptiveStatistics#

Computes univariate statistics of each selected array: minimum, maximum, mean, raw moments, standard deviation, skewness and kurtosis. Assessment expresses each value as its number of standard deviations from the mean (signed or unsigned). Use it for summary statistics of fields over a mesh or table; counts are per point or cell, not weighted by cell size. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.

Common mistakes and assumptions:

  • On a non-uniform mesh the mean is not a volume average; use integrate and divide by volume for that.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DescriptiveStatistics. Identity: filters/DescriptiveStatistics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model. Accepted data: image data (uniform rectilinear grids) (vtkImageData); curvilinear structured grids (vtkStructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkStructuredGrid","vtkPolyData","vtkUnstructuredGrid","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
ModelInput Optional data input for the native ModelInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: A previously-calculated model with which to assess a separate dataset. This input is optional. Accepted data: tables (rows and columns) (vtkTable); multiblock datasets (vtkMultiBlockDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeMode Attribute association whose arrays are analysed; VariablesofInterest names are looked up in it. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
Deviationsshouldbe Should the assessed values be signed deviations or unsigned? {"type":"enum","values":["Unsigned","Signed"]} native initialisation / omitted "Unsigned"
Task Specify the task to be performed: modeling and/or assessment. <ol> <li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li> <li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li> <li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li> <li> "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset. The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.</li> </ol> When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The <i>Training fraction</i> setting will be ignored for tasks 1 and 3. {"type":"enum","values":["Detailed model of input data","Model a subset of the data","Assess the data with a model","Model and assess the same data"]} native initialisation / omitted "Detailed model of input data"
TrainingFraction Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDescriptiveStatistics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDisk#

Creates a flat annulus (a disk with a central hole) in the x-y plane centred at the origin, as polydata made of quadrilaterals: InnerRadius to OuterRadius, divided into RadialResolution rings and CircumferentialResolution sectors. Use it as an inlet or outlet patch, seed surface or reference geometry. The curated disk operation exposes the same source with Schemaxis defaults.

Common mistakes and assumptions:

  • ParaView's default InnerRadius is 0.5, so the disk has a hole; set it to 0 for a solid disk.
  • Position and orientation are fixed (x-y plane at the origin); move it with a transform.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Disk. Identity: sources/DiskSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CircumferentialResolution Set the number of points in circumferential direction. {"maximum":1024,"minimum":3,"type":"integer"} native initialisation / omitted 3
InnerRadius Specify inner radius of hole in disc. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
OuterRadius Specify outer radius of disc. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
RadialResolution Set the number of points in radial direction. {"maximum":1024,"minimum":3,"type":"integer"} native initialisation / omitted 3

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDisk"
}

pvDistributePoints#

Redistributes the points of a point set across MPI processes into spatially contiguous regions with roughly equal point counts, by recursively splitting the points in two (a k-d tree). Output is polydata containing the points and their point data but no cells; input cells are ignored. Use it in MPI runs to balance particle or point-cloud data before point-based processing.

Common mistakes and assumptions:

  • The output has no cells, so it is not drawn and cell-based filters see nothing.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DistributePoints. Identity: filters/DistributePoints. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDistributePoints",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvDistributedTrivialProducer#

Trivial producer (vtkDistributedTrivialProducer) that takes its data from a dataset previously registered under a key by native code in the same process (SetGlobalOutput); UpdateDataset names that key. Schemaxis provides no way to register such a dataset, so in a workflow the key finds nothing and the node has no data. It exists for in-situ and embedding applications.

Common mistakes and assumptions:

  • Schemaxis has no authored way to hand a dataset to a trivial producer, so the node is expected to produce an empty output; this has not been run.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: DistributedTrivialProducer. Identity: sources/DistributedTrivialProducer. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
UpdateDataset This property allow to initialize the trivial producer based on a previously registered dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
WholeExtent The values of this property specify the whole extent of the topologically regular grid. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvDistributedTrivialProducer"
}

pvENZOAMRParticlesReader#

Reads particles from an Enzo AMR output (the .hierarchy or .boundary file of a data dump) into a multiblock dataset with one polydata block of particle points per grid. It can keep only every Frequency-th particle, particles inside a box, or one particle type (dark matter, star or tracer). Use pvEnzoReader for the gas fields of the same output.

Common mistakes and assumptions:

  • ParticleType filtering works only when the file has a particle_type array; otherwise all particles are returned.
  • MaxLocation is the upper corner of the filter box, although ParaView's own documentation calls it the minimum.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ENZOAMRParticlesReader. Identity: sources/EnzoParticlesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FilterLocation Turns on filtering of particles by location {"type":"boolean"} native initialisation / omitted false
Frequency This property sets the frequency interval for loading particles. {"type":"integer"} native initialisation / omitted 1
MaxLocation Upper corner [x, y, z] of the axis-aligned box used when FilterLocation is true: particles with any coordinate above it (or below MinLocation) are dropped. Coordinates are in the file's units. ParaView's own documentation calls this the minimum location; the reader uses it as the maximum. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
MinLocation This property sets the minimum 3-D coordinate location by which the particles will be filtered out. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ParticleArrayStatus Names of the particle arrays to read (for example particle_mass or velocity components); unlisted arrays are skipped, saving memory and time. Positions are always read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ParticleType Keeps only particles of one Enzo particle type: Dark Matter, Active (Star) or Passive (Tracer), compared with each particle's particle_type value; All Particles disables the test. Choose a type to study one population, e.g. stars formed in a galaxy simulation. {"type":"enum","values":["All Particles","Dark Matter","Active (Star)","Passive (Tracer)"]} native initialisation / omitted "All Particles"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvENZOAMRParticlesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvERFHDF5datareader#

Reads ESI Result Format files stored in HDF5 (.erfh5), as written by ESI structural and crash solvers, into a partitioned dataset collection. A file holds stages (top-level groups; the "post" link names the default stage), each with constant data (mesh connectivity, nodes) and singlestate time states; Stages, Blocks and Variables choose what is read. Multistate data are not supported.

Common mistakes and assumptions:

  • Variable names are offered in lower case because the reader treats them case-insensitively; use the lower-case form.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: ERFHDF5datareader. Identity: sources/ERFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Blocks Names of the blocks stored in the ERF HDF5 file to load; the available names are listed by the file itself. Listing names replaces ParaView’s current selection, and unlisted blocks are not read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the file name for the ERF reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Stages Names of the stages (result sets) stored in the ERF HDF5 file to load; the available names are listed by the file itself. Listing names replaces ParaView’s current selection, and unlisted stages are not read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Variables List of variables to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvERFHDF5datareader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvElevation#

Adds a floating-point point array named Elevation by projecting each point onto the segment from LowPoint to HighPoint and mapping its position linearly into ScalarRange: the LowPoint end gets the first value, the HighPoint end the second, and points beyond either end are clamped. Use it for height colouring, a linear test ramp or a coordinate along any direction; elevation is the curated version and pvCellGridElevation works on cell grids.

Common mistakes and assumptions:

  • Points beyond the segment all receive the end values; extend LowPoint and HighPoint over the data if the full variation is wanted.
  • LowPoint and HighPoint may receive input-dependent ParaView defaults; set them explicitly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Elevation. Identity: filters/ElevationFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset to the Elevation filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
HighPoint This property defines the high end of the direction vector (large scalar values). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
LowPoint This property defines low end of the direction vector (small scalar values). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ScalarRange This property determines the range into which scalars will be mapped. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvElevation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvEllipse#

Creates an elliptical arc or full ellipse as a polyline: centred at Center, in the plane normal to Normal, with major radius given by the length of MajorRadiusVector and minor radius Ratio × major. StartAngle and SectorAngle (degrees, measured from the major axis) select part of the perimeter, and Close joins the ends. Use it for annotation, seed curves or circular probes (Ratio 1 gives a circle).

Common mistakes and assumptions:

  • MajorRadiusVector must not be parallel to Normal; VTK then reports an error and produces nothing.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Ellipse. Identity: sources/EllipseSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center The center of the ellipse. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Close When on, closes the elliptical arc by adding a line segment between the last point and the first point. {"type":"boolean"} native initialisation / omitted false
MajorRadiusVector The origin of polar angle and the major radius size. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Normal The normal of the plane containing the ellipse. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Ratio Ratio of the ellipse defined as minor radius / major radius. Valid values are in the range [0.001, 1.0]. {"maximum":1.0,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001
Resolution Number of line segments in the polyline defining the ellipse edge. {"maximum":1024,"minimum":8,"type":"integer"} native initialisation / omitted 8
SectorAngle The angular sector occupied by the arc, measured in degrees from the Start Angle. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
StartAngle The angle (in degrees) where the ellipse begins relative to the Major Radius Vector. {"maximum":360.0,"minimum":-360.0,"type":"number"} native initialisation / omitted -360.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEllipse"
}

pvEnSightMasterServerReader#

Reads EnSight data written in parallel through a Server-of-Servers master file (.sos) that lists one .case file per partition; the partitions are combined into one multiblock dataset of EnSight parts with the selected node and element variables. Choose it for EnSight output split across processes; for an ordinary .case file use pvEnSightReader. It reads the time given by SetTimeValue and exposes a ByteOrder setting for binary files.

Common mistakes and assumptions:

  • ByteOrder starts as BigEndian; if a binary case loads with nonsensical values, try LittleEndian.
  • CaseFileName must be the .sos master file, not one of the .case files it lists.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EnSightMasterServerReader. Identity: sources/ensightMS. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ByteOrder This property indicates the byte order of the binary file(s). {"type":"enum","values":["BigEndian","LittleEndian"]} native initialisation / omitted "BigEndian"
CaseFileName This property specifies the name of the .sos file for the EnSight Master Server reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SetTimeValue This property indicates which time value to read. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEnSightMasterServerReader",
  "options": {
    "CaseFileName": "REPLACE_WITH_VALUE"
  }
}

pvEnSightReader#

Reads an EnSight 6 or EnSight Gold case (.case, ASCII or binary), a post-processing format exported by many CFD and structural solvers (OpenFOAM's foamToEnsight among them). Output is a multiblock dataset with one block per EnSight part, carrying the node (point) and element (cell) variables selected in PointArrays and CellArrays; transient cases expose their time steps. Use pvEnSightMasterServerReader for a parallel .sos master file and pvWriteEnSightWriter to write EnSight.

Common mistakes and assumptions:

  • CaseFileName must be the .case file; the geometry and variable files it names are located relative to it.
  • ApplyTetrahedralize (default false) splits every cell into tetrahedra, multiplying the cell count; use it only to work around non-manifold EnSight meshes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EnSightReader. Identity: sources/ensight. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ApplyTetrahedralize This property set if we want to tetrahedralize the output to prevent non manifold mesh later (generated by the Ensight Solver). {"type":"boolean"} native initialisation / omitted false
CaseFileName This property specifies the case file name for the EnSight reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEnSightReader",
  "options": {
    "CaseFileName": "REPLACE_WITH_VALUE"
  }
}

pvEnsembleDataReader#

Reads a ParaView ensemble table (.pve): a CSV file with a header row in which each further row describes one ensemble member through parameter columns, and the last column gives that member's data file, relative to the .pve file. CurrentEnsembleMember selects which member is read; the output is whatever that file's reader produces. Use it to step through a parameter study by member number; read a member's file directly when only one is needed.

Common mistakes and assumptions:

  • Member files are opened with ParaView's reader for their extension, so all members should share one format.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EnsembleDataReader. Identity: sources/EnsembleDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CurrentEnsembleMember The index of the dataset in the ensemble. {"type":"integer"} native initialisation / omitted 1
FileName This property specifies the PVE file name Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEnsembleDataReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvEnvironmentAnnotation#

Produces a text annotation stating the user name, system name, date and time and, optionally, the input's file name, for stamping provenance on images. ParaView marks its output port as text: it is an annotation, not a dataset, and the input data are not passed through. The text depends on the machine, user and run time.

Common mistakes and assumptions:

  • Date/time and user name differ between runs; disable them when images are compared across runs or machines.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EnvironmentAnnotation. Identity: filters/EnvironmentAnnotation. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Set the input of the filter. Accepted data: any data object (vtkDataObject). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DisplayDate Toggle Date/Time Visibility. {"type":"boolean"} native initialisation / omitted false
DisplayFileName Toggle File Name Visibility. {"type":"boolean"} native initialisation / omitted false
DisplayFilePath Toggle Show Full File Path. {"type":"boolean"} native initialisation / omitted false
DisplaySystemName Toggle System Name Visibility. {"type":"boolean"} native initialisation / omitted false
DisplayUserName Toggle User Name Visibility. {"type":"boolean"} native initialisation / omitted false
FileName Annotation of file name. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEnvironmentAnnotation",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvEnzoReader#

Reads an Enzo AMR simulation output (the .hierarchy or .boundary file) into a hierarchical-box (overlapping AMR) dataset of the selected cell and point fields, refinement levels 0 to Level. ConvertToCGS optionally converts the fields from Enzo code units to CGS. Use it for Enzo gas and field data; use pvENZOAMRParticlesReader for its particles.

Common mistakes and assumptions:

  • Level defaults to 1, so only the two coarsest levels are loaded; raise it to see the finest data.
  • Fields stay in Enzo code units unless ConvertToCGS is true; check which before comparing with physical values.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EnzoReader. Identity: sources/EnzoReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred Enzo fields to load, such as Density, Temperature or velocity components. Unlisted fields are not read, which saves memory on deep hierarchies. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ConvertToCGS This property specifies whether or not units will be converted to CGS. {"type":"boolean"} native initialisation / omitted false
EnableCaching Keep AMR blocks that have already been read in memory, so later updates that change the level or array selection, or revisit a time, do not reread them from disk. It does not change the data produced. {"type":"boolean"} native initialisation / omitted false
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Level This property specifies the desired level of resolution that will be visible. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus Names of the point-centred arrays to load, when the Enzo output provides any; most Enzo fields are cell-centred and belong in CellArrayStatus. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEnzoReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvEqualizerFilter#

Applies a frequency-domain equalizer to signal columns of a table: each column is Fourier transformed, its spectrum multiplied by a piecewise-linear gain curve given in EqualizerPoints, and transformed back. Output ports: 0 the spectrum, 1 the filtered signal (Result), 2 the normalized spectrum; select one with {"node": id, "port": n}. Use it for band-pass or notch filtering of probe or sensor time series.

Common mistakes and assumptions:

  • Rows are assumed to be equally spaced samples at SamplingFrequencyHz; irregular time steps give a wrong frequency axis.
  • With fewer than two equalizer points the signal is not modified.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EqualizerFilter. Identity: filters/EqualizerFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: tables (rows and columns) (vtkTable). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AllColumns Use for all columns of table. {"type":"boolean"} native initialisation / omitted false
Array Specify the name of a scalar array which will be used to FFT. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
EqualizerPoints This property defines the interactive points of the equalizer. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SamplingFrequencyHz Set sampling frequency of signal. {"type":"integer"} native initialisation / omitted 1
SpectrumGaindB Specify a gain coefficient (in dB) to apply to the spectrum of the input signal. Used only for convenient viewing. {"maximum":50,"minimum":-50,"type":"integer"} native initialisation / omitted -50

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 3,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEqualizerFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvEvenlySpacedStreamlines2D#

Fills a 2-D vector field with streamlines at roughly uniform spacing (Jobard–Lefer algorithm): starting at StartPosition it integrates forward and backward, seeds new lines SeparatingDistance beside existing ones, and stops a line when it comes closer than SeparatingDistance × SeparatingDistanceRatio to another, closes a loop, leaves the domain, slows below TerminalSpeed or reaches MaximumSteps. Input must lie in the x-y plane with in-plane point vectors; output is polylines with IntegrationTime, interpolated fields and a ReasonForTermination cell array. Use it for even flow pictures of 2-D slices; streamTracer seeds from a chosen source.

Common mistakes and assumptions:

  • A slice not lying in the x-y plane gives wrong or no streamlines; transform it into x-y first.
  • With the default Cell Length unit, distances are multiples of the diagonal of the cell containing StartPosition, so moving the seed rescales all spacings; choose Length for dataset units.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: EvenlySpacedStreamlines2D. Identity: filters/EvenlySpacedStreamlines2D. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ClosedLoopMaximumDistance Loops are considered closed if the have two points at distance less than this. This is expressed in IntegrationStepUnit. {"type":"number"} native initialisation / omitted 1
ComputeVorticity Specify whether to compute vorticity. {"type":"boolean"} native initialisation / omitted false
InitialStepLength This property specifies the initial integration step size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4), it is fixed (always equal to this initial value) throughout the integration. {"type":"number"} native initialisation / omitted 1
IntegrationStepUnit This property specifies the unit for Initial integration step size. The Length unit refers to the arc length that a particle travels/advects within a single step. The Cell Length unit represents the step size as a number of cells. {"type":"enum","values":["Length","Cell Length"]} native initialisation / omitted "Length"
IntegratorType This property determines which integrator (with increasing accuracy) to use for creating streamlines. {"type":"enum","values":["Runge-Kutta 2","Runge-Kutta 4"]} native initialisation / omitted "Runge-Kutta 2"
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MaximumSteps This property specifies the maximum number of steps, beyond which streamline integration is terminated. {"type":"integer"} native initialisation / omitted 1
SeparatingDistance Specify the separating distance between streamlines expressed in IntegrationStepUnit. {"type":"number"} native initialisation / omitted 1
SeparatingDistanceRatio Specifies SeparatingDistanceRatio. If streamlines get closer than SeparatingDistance * SeparatingDistanceRatio to other streamlines integration stops. {"type":"number"} native initialisation / omitted 1
StartPosition Specify the starting point (seed) of the first streamline in the global coordinate system. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
Vectors This property contains the name of the vector array from which to generate streamlines. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvEvenlySpacedStreamlines2D",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExodusIIReader#

Reads Exodus II finite-element results (.e, .exo, .g, .ex2 …, written by SEACAS-based codes such as Sierra, MOOSE or Cubit) into a multiblock dataset of unstructured grids: element blocks, optional face and edge blocks, node, side and element sets, and global variables, with nodal and element result variables per time step. By default node positions include the displacement vector (ApplyDisplacements, scaled by DisplacementMagnitude). Use pvRestartedSimExodusReader for a restarted run described by a metadata file, or pvIOSSReader, the IOSS-based alternative.

Common mistakes and assumptions:

  • FilePattern, FilePrefix and XMLFileName are optional, as their ParaView file lists are marked optional. Leave them out to read FileName as given: FilePattern and FilePrefix rebuild the file name from a printf-style pattern, so supplying them changes which file is read, and XMLFileName names an optional part and material description.
  • VTK's Exodus reader starts with every result variable disabled; list the PointVariables and ElementVariables you need, or the blocks arrive without fields.
  • Coordinates are deformed by default; set ApplyDisplacements to false to see the undeformed mesh.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExodusIIReader. Identity: sources/ExodusIIReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AnimateVibrations If this flag is on and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid. If this flag is off and HasModeShapes is on, this reader ignores time. This flag has no effect if HasModeShapes is off. {"type":"boolean"} native initialisation / omitted false
ApplyDisplacements Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter. {"type":"boolean"} native initialisation / omitted false
DisplacementMagnitude When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling. {"type":"number"} native initialisation / omitted 1
EdgeBlocks Use this property to select which blocks of edges should be loaded. All edges in the same block will have the same interpolant (linear, quadratic, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeMapArrayStatus Specify which maps defined over edges in the mesh should be loaded. An edge map is a renumbering of all the edges (across all the edge blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetArrayStatus An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge. The accompanying EdgeSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetResultArrayStatus An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the EdgeSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeVariables Use this property to select which variables defined over edges should be loaded. Edges are oriented boundaries of one or more higher-dimensional cells also present in the mesh. Edge variables specify a single value per entry in some edge block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlocks Use this property to select which blocks of elements (cells) should be loaded. All elements (cells) in the same block will have the same interpolant (tetrahedral, triangular, trilinear hexahedral, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementMapArrayStatus Specify which maps defined over elements (cells) in the mesh should be loaded. An element map is a renumbering of all the elements (across all the element blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. These are sometimes called new-style maps because they are specified differently than in older Exodus files, which only allowed a single element map. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetArrayStatus An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element. The accompanying ElementSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetResultArrayStatus An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right. Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the ElementSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementVariables Use this property to select which variables defined over elements (cells) should be loaded. Element variables specify a single value per entry in some element block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlocks Use this property to select which blocks of faces should be loaded. All faces in the same block will have the same interpolant (triangular, bilinear quadrilateral, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceMapArrayStatus Specify which maps defined over faces in the mesh should be loaded. A face map is a renumbering of all the faces (across all the face blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetArrayStatus An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face. The accompanying FaceSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetResultArrayStatus An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the FaceSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceVariables Use this property to select which variables defined over faces should be loaded. Faces are oriented boundaries of one or more higher-dimensional cells also present in the mesh. Face variables specify a single value per entry in some face block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the file name for the Exodus reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FilePattern This property contains a text string specifying the pattern used to load files. There are two parts to it: the prefix (%s) and the file number (%i). The format used is the same as that used for printf. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FilePrefix This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property). {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileRange This property controls the indices of the first and last files to be read. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
GenerateFileIdArray Should each cell in the mesh be assigned an integer identifying the file it came from? If turned on, a cell variable named "FileId" should be present. {"type":"boolean"} native initialisation / omitted false
GenerateGlobalElementIdArray Should the reader retrieve the first new-style element map, or if that is not present, the solitary old-style element map (which always exists but may be procedurally generated if it is not stored with the file)? {"type":"boolean"} native initialisation / omitted false
GenerateGlobalNodeIdArray Should the reader retrieve the first new-style node map, or if that is not present, the solitary old-style node map (which always exists but may be procedurally generated if it is not stored with the file)? {"type":"boolean"} native initialisation / omitted false
GenerateObjectIdCellArray Specifies whether a variable named "ObjectId" should be created for each entry of each block and set being loaded and assigned the identifying number of the block or set, so that given a cell one can readily identify the block or set it came from. This is useful for coloring a mesh by block ID or set ID. {"type":"boolean"} native initialisation / omitted false
GlobalVariables Use this property to select which global (i.e., per-mesh) variables should be loaded. Global variables are stored as arrays in the field data of the reader's output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HasModeShapes Some simulations overload the Exodus time steps to represent mode shapes. In this case, it does not make sense to iterate over the "time steps", because they are not meant to be played in order. Rather, each represents the vibration at a different "mode." Setting the value of this property to 1 changes the semantics of the reader to not report the time steps to downstream filters. {"type":"boolean"} native initialisation / omitted false
IgnoreFileTime If on, the reader will ignore the time value reported at each time step, using the index of the time step as the time value. This is useful for Exodus files where different time steps are overloaded to represent different aspects of a data set rather than the data set at different time values. {"type":"boolean"} native initialisation / omitted false
ModeShape Specify which mode shape to animate when HasModeShapes is on. {"type":"integer"} native initialisation / omitted 1
NodeMapArrayStatus Specify which maps defined over nodes (points) in the mesh should be loaded. A node map is a renumbering of all the points in a file from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. These are sometimes called new-style maps because they are specified differently than in older Exodus files, which only allowed a single node map. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetArrayStatus An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node. This property specifies which of those sets should be loaded. The accompanying NodeSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetResultArrayStatus An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the NodeSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointVariables Use this property to select which nodal (i.e., per-point) variables should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSetArrayStatus An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side. For example, a hexahedron has 18 sides: 6 faces and 12 edges. Any of these sides may be individually called out in a set and assigned a result value. The accompanying SideSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSetResultArrayStatus An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side. For example, a hexahedron has 18 sides: 6 faces and 12 edges. Any of these sides may be individually called out in a set and assigned a result value. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the SideSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseLegacyBlockNamesWithElementTypes In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block. This has issues with consistency when naming blocks across ranks for partitioned files. Hence we no longer do that. For legacy pipelines, one can enable the old behavior by setting this flag to true. {"type":"boolean"} native initialisation / omitted false
UseMetaFile Whether FileName is read as a restart metadata file listing the real Exodus files (true) or as the Exodus file(s) themselves (false). For this reader leave it false; the restart metadata form is pvRestartedSimExodusReader, where it is true. {"type":"boolean"} native initialisation / omitted false
XMLFileName This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExodusIIReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvExtractAMRBlocks#

Extracts chosen datasets (boxes) from an AMR input (vtkUniformGridAMR), each identified by its refinement level and its index within that level. The output is a multiblock with one block per level, each holding the extracted uniform grids as pieces. Use it to inspect or process individual AMR patches; pvConvertAMRdatasettoMultiblock or pvResampleAMR convert the whole hierarchy instead.

Common mistakes and assumptions:

  • SelectedDataSets is a flat list of (level, index) pairs; Schemaxis rejects an odd number of entries.
  • Indices restart at 0 on every level; they are not global block numbers.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractAMRBlocks. Identity: filters/ExtractHierarchicalDataSets. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Datasets filter. Accepted data: AMR data (vtkUniformGridAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUniformGridAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SelectedDataSets Specify a pair, level and dataset index, for every dataset from the input AMR dataset to extract. Complete tuples of 2 values. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractAMRBlocks",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractAttributes#

Converts one attribute association of the input (points, cells, field data, vertices, edges or rows) into a table (vtkTable): one column per array, one row per point or cell (or other element). Composite input gives a multiblock of tables. Use it to inspect or export raw array values, e.g. as CSV through a table writer. Geometry and connectivity are dropped unless AddMetaData adds coordinates.

Common mistakes and assumptions:

  • ParaView's default association is Points; set FieldAssociation to Cells for cell-centred solver fields.
  • Point coordinates are not included by default; enable AddMetaData when you need them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractAttributes. Identity: filters/AttributeDataToTableFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AddMetaData It is possible for this filter to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is pointset) or structured coordinates etc. To enable this addition of extra information, turn this flag on. Off by default. {"type":"boolean"} native initialisation / omitted false
FieldAssociation Select the attribute data to pass. {"type":"enum","values":["Points","Cells","Field Data","Vertices","Edges","Rows"]} native initialisation / omitted "Points"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractAttributes",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractBlock#

Full native Extract Block: keeps selected blocks of a multiblock, partitioned dataset collection or AMR input, chosen by Selectors (path expressions) evaluated against the data assembly named in Assembly — the block hierarchy, or an assembly supplied by readers such as IOSS or CGNS that groups blocks by meaning. The composite type is kept (overlapping AMR becomes a partitioned dataset collection). Use extractBlock when the hierarchy is enough.

Common mistakes and assumptions:

  • Selectors must match the chosen assembly; a hierarchy path does not select anything in a reader-defined assembly.
  • Without selectors no block is selected and the output is empty.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractBlock. Identity: filters/ExtractBlock. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input to this filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet); AMR data (vtkUniformGridAMR); partitioned dataset collections (vtkPartitionedDataSetCollection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet","vtkUniformGridAMR","vtkPartitionedDataSetCollection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specify selectors to choose blocks to extract. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Selectors Sepecify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractBlock",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractCTHParts#

Specialized for CTH shock-physics results: for each selected cell-centred volume-fraction array (VolumeArrays) it converts the array to point data and contours it at VolumeFractionValue (ParaView default 0.45), giving one material surface per array. Output is a multiblock with one polydata block per selected array, optionally clipped by a plane (ClipType, ParaView default None) and capped to look closed. Input is CTH data: non-overlapping AMR or multiblock rectilinear grids with cell data, e.g. from pvSpyPlotReader.

Common mistakes and assumptions:

  • VolumeArrays has no static default; list the material volume-fraction arrays explicitly.
  • The surface level is VolumeFractionValue (0.45 by default, not the 0.5 stated in the upstream description); keep the same value when comparing runs.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractCTHParts. Identity: filters/CTHPart. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract CTH Parts filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CapSurfaces When enabled, volume surfaces are capped to produce visually closed surface. {"type":"boolean"} native initialisation / omitted false
ClipType This property specifies whether to clip the dataset, and if so, it also specifies the parameters of the plane with which to clip. {"type":"typed proxy","choices":["None","Plane"]} native initialisation / omitted {"type":"None"}
GenerateSolidGeometry Generate solid output with 3D cells. When set to false, 2D contours are generated. {"type":"boolean"} native initialisation / omitted false
GenerateTriangles Triangulate results. When set to false, the internal cut and contour filters are told not to triangulate results if possible. {"type":"boolean"} native initialisation / omitted false
RemoveGhostCells When set to false, the output surfaces will not hide contours extracted from ghost cells. This results in overlapping contours but overcomes holes. Default is set to true. {"type":"boolean"} native initialisation / omitted false
VolumeArrays This property specifies the name(s) of the volume fraction array(s) for generating parts. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VolumeFractionValue The value of this property is the volume fraction value for the surface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested ClipType → None#

Syntax: {"type":"None","options":{...}}. Native identity: implicit_functions/None. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested ClipType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
ClipType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractCTHParts",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractCellsAlongLine#

Extracts every cell of the input that the straight segment from Point1 to Point2 intersects and outputs those cells, with their point and cell data, as an unstructured grid. Use it to inspect the actual mesh cells crossed by a probe line, for example before plotting with probeLine; probeLine instead samples interpolated values at evenly spaced points. Use pvExtractCellsAlongLinesCustomSource for polylines or several lines.

Common mistakes and assumptions:

  • Cells that only touch the line at a point or edge may or may not be counted; extend the segment slightly if boundary cells matter.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractCellsAlongLine. Identity: filters/ExtractCellsAlongLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Point1 This property controls the coordinates of the first endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property controls the coordinates of the second endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractCellsAlongLine",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractCellsAlongLinesCustomSource#

Extracts the input cells intersected by the line and polyline cells of a second dataset (Source, polydata or unstructured grid) and outputs them as an unstructured grid. Use it with a curved or multi-segment path, e.g. a traced streamline or a polyline read from a file; for a single straight segment pvExtractCellsAlongLine is simpler.

Common mistakes and assumptions:

  • Only line and polyline cells of Source are used; polygons, vertices or 3-D cells in Source are ignored, so extract edges or build a polyline first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractCellsAlongLinesCustomSource. Identity: filters/ExtractCellsAlongLineCustom. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset composed of the lines and poly lines used to extract cells in the input. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData","vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractCellsAlongLinesCustomSource",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvExtractCellsByRegion#

Extracts the cells lying entirely inside (ParaView default) or entirely outside an implicit region — a Plane (ParaView's default choice, whose inside is the side opposite its normal), Box or Sphere — without cutting them, and outputs an unstructured grid. Extractintersected adds cells straddling the region boundary and Extractonlyintersected keeps only those. Use it to cut out a sub-volume of whole original cells; clip cuts cells exactly at the surface and slice returns the surface itself.

Common mistakes and assumptions:

  • The cut is jagged because whole cells are kept; use clip for an exact boundary.
  • For a Plane, inside is the negative side, opposite to the normal; flip the normal or choose outside to keep the other half.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractCellsByRegion. Identity: filters/ExtractGeometry. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Slice filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Extractintersected This parameter controls whether to extract cells that are on the boundary of the region. {"type":"boolean"} native initialisation / omitted false
ExtractionSide This parameter controls whether to extract cells that are inside or outside the region. {"type":"enum","values":["outside","inside"]} native initialisation / omitted "outside"
Extractonlyintersected This parameter controls whether to extract only cells that are on the boundary of the region. If this parameter is set, the Extraction Side parameter is ignored. If Extract Intersected is off, this parameter has no effect. {"type":"boolean"} native initialisation / omitted false
IntersectWith This property sets the region used to extract cells. {"type":"typed proxy","choices":["Box","Plane","Sphere"]} native initialisation / omitted {"type":"Box"}

Nested IntersectWith → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: implicit_functions/Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
IntersectWith.options.Bounds Reference box [xmin, xmax, ymin, ymax, zmin, zmax] used only when UseReferenceBounds is true; the box is then these bounds scaled by Length, rotated by Rotation and translated by Position, all about the coordinate origin, so Length [1, 1, 1], Rotation [0, 0, 0] and Position [0, 0, 0] reproduce Bounds exactly. Ignored otherwise. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
IntersectWith.options.Length With UseReferenceBounds false: edge lengths [Lx, Ly, Lz] of the box along its own axes (ParaView applies them as scale factors to a unit cube). With UseReferenceBounds true: dimensionless scale factors applied to the Bounds box about the coordinate origin. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
IntersectWith.options.Position With UseReferenceBounds false: world coordinates [x, y, z] of the box’s minimum corner (before rotation); the box extends from Position to Position + Length along its own axes. With UseReferenceBounds true: a translation applied to the transformed Bounds box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
IntersectWith.options.Rotation Rotation angles [rx, ry, rz] about the x, y and z axes, applied about the box’s local origin (its minimum corner at Position, not its centre; with UseReferenceBounds true, about the coordinate origin). The angles are combined in VTK’s Z-X-Y convention: the box transform is Translate · RotateZ · RotateX · RotateY · Scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
IntersectWith.options.UseReferenceBounds Chooses how the box is defined. False: the box is a unit cube scaled by Length, rotated about its corner and placed at Position. True: the box starts from Bounds, and Length, Rotation and Position act as scale, rotation and translation relative to it (about the coordinate origin). {"type":"boolean"} native initialisation / omitted false

Nested IntersectWith → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
IntersectWith.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
IntersectWith.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
IntersectWith.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested IntersectWith → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
IntersectWith.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
IntersectWith.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractCellsByRegion",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractCellsByType#

Keeps only the cells whose VTK cell type is listed in CellTypes, e.g. the Tetrahedron cells of a mixed mesh, or the Triangle and Quadrilateral faces of a surface. The output has the same dataset type as the input; structured inputs (image, rectilinear or structured grids) consist of one cell type, so they come through either whole or empty. Use pvExtractSelection to pick cells by ID or value instead.

Common mistakes and assumptions:

  • No type is selected until you list one, and an empty selection gives an empty output.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractCellsByType. Identity: filters/ExtractCellsByType. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellTypes Select the cell types to extract. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractCellsByType",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractComponent#

Copies one component of a multi-component array (e.g. the z velocity Uz from U) into a new single-component array named OutputArrayName on the same points or cells; the dataset is otherwise unchanged. Use it when a later operation (contour, threshold) needs a scalar. calculator can do the same with an expression such as U_Z.

Common mistakes and assumptions:

  • Component is zero-based: 0 is x, 1 is y, 2 is z.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractComponent. Identity: filters/ExtractComponent. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the Extract Component filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Component This property indicates the component of the array to be extracted. {"type":"integer"} native initialisation / omitted 1
InputArray This property indicates the name of the array to be extracted. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
OutputArrayName This property indicates the name of the output scalar array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractComponent",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractEdges#

Native Extract Edges, the same filter as edges: every cell edge becomes a line cell in an output polydata wireframe, with shared edges emitted once and cell data copied from the lowest-numbered cell using the edge. Use edges unless you need the generated pv identifier; featureEdges or pvFeatureEdges return only boundary and sharp edges.

Common mistakes and assumptions:

  • Volume meshes produce all interior edges; ParaView warns that structured inputs can use much memory.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractEdges. Identity: filters/ExtractEdges. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Edges filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractEdges",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractEnclosedPoints#

Keeps the input points that lie inside a closed, manifold polygonal Surface (second input) and outputs them as a point cloud (polydata) on port 0; with GenerateOutliers, port 1 holds the points outside. Only points and their point data are kept, not the input's cells. Use it to select particles or probe points within a body; to keep mesh cells, use a clip instead.

Common mistakes and assumptions:

  • With an open or non-manifold surface the inside/outside test is undefined; enable CheckSurface so the filter first checks that the surface is closed. If that check fails the filter reports "Bad enclosing surface" and stops without producing output (the node fails); it does not mark the points as outside.
  • Surface must be a single polygonal surface (not composite); extract the surface of a solid mesh first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractEnclosedPoints. Identity: filters/ExtractEnclosedPoints. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to extract points from. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Surface Required data input for the native Surface port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the closed and manifold surface. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CheckSurface Specify whether to check the surface for closure. If on, then the algorithm first checks to see if the surface is closed and manifold. {"type":"boolean"} native initialisation / omitted false
GenerateOutliers If checked, then a second output will be created that contains the outlier points. {"type":"boolean"} native initialisation / omitted false
GenerateVertices If checked, then the outputs will contain a poly-vertex cell. This takes a lot more memory, however certain filters many requires cells to be present to function properly. {"type":"boolean"} native initialisation / omitted false
Tolerance Specify the tolerance on the intersection. The tolerance is expressed as a fraction of the diagonal of the bounding box of the enclosing surface. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractEnclosedPoints",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Surface": "UPSTREAM_Surface"
  }
}

pvExtractGhostCells#

Extracts only the ghost cells of the input (the overlap layers that parallel or partitioned data carry to neighbouring pieces) so they can be inspected, and records the original ghost flags in an array named ArrayName. Use it to debug decompositions or ghost-cell generation; data without ghost cells gives an empty output.

Common mistakes and assumptions:

  • ArrayName must differ from vtkGhostType, or the extracted cells are treated as ghosts again and hidden.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractGhostCells. Identity: filters/ExtractGhostCells. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ArrayName Name of the ghost cell array in the output. It must be different to vtkGhostType in order for the cells to be displayed. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractGhostCells",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractLocation#

Looks up one point in space: in Interpolate At Location mode it outputs a single point with all data interpolated there (a probe); in Extract Cell At Location mode, the ParaView default, it outputs the cell or cells containing the location with their data. Use it for a monitoring-point value or to inspect the element at a position; use probeLine or pvPlotOverLine for lines.

Common mistakes and assumptions:

  • A location outside the mesh gives an empty result (or zero-filled values when interpolating); check the bounds.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractLocation. Identity: filters/ExtractLocation. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input dataset producer. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Location Select the location of interest in 3D space. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Mode Select whether to interpolate (probe) data attributes at the specified location, or to extract cell(s) containing the specified location. {"type":"enum","values":["Interpolate At Location","Extract Cell At Location"]} native initialisation / omitted "Interpolate At Location"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractLocation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractParticlesOverTime#

Finds the particles of a temporal point dataset (Particles port) that pass through a volume (Volume port, a dataset with 3-D cells) at any time step, and outputs the Particles data restricted to those particles, still time-dependent. It visits every input time step, so it can be slow. Particles are matched between steps by IdChannelArray. Use it to isolate particles crossing a region such as an inlet or a reaction zone; pvExtractCellsByRegion selects by position at one time only.

Common mistakes and assumptions:

  • If point order changes between steps and no id array identifies particles, different particles are confused; name an id array in IdChannelArray.
  • The Volume must contain 3-D cells; a closed surface does not count as a volume here.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractParticlesOverTime. Identity: filters/ExtractParticlesOverTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Particles Required data input for the native Particles port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The moving particles. This input should be temporal vtkDataSet and should contain points evolving over time. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Volume Required data input for the native Volume port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The volumetric data to detect if particles pass through. This dataset should contain volumetric cells like hexahedrons or tetrahedrons. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
IdChannelArray Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is set to "Global or Local IDs", the global point ids are used if they exist. Otherwise, the point indices are used. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractParticlesOverTime",
  "inputs": {
    "Particles": "UPSTREAM_Particles",
    "Volume": "UPSTREAM_Volume"
  }
}

pvExtractRegionSurface#

Extracts polygonal surfaces of an unstructured grid on its outer boundary and also on internal interfaces between regions, where regions are defined by an integer cell array (RegionArrayName, ParaView default "material"). It suits multi-material meshes: each interface face is output once or once per side (SingleSided), and output faces can record their source cell (OrigCellIds) and the face of that cell (CellFaceIds). Use surface or pvExtractSurface when only the outer boundary is needed.

Common mistakes and assumptions:

  • The region array must be an integer (vtkIntArray) cell array; an array of another type, or a name that does not exist, is not used, and only the outer surface results.
  • Interfaces are found for unstructured-grid input; other dataset types get the ordinary outer surface.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractRegionSurface. Identity: filters/DataSetRegionSurfaceFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Surface filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
InterfaceIDsName This the name of the input and output interface id field data array {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
MaterialIDsName This the name of the input and output material id field data array {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
MaterialPIDsName This the name of the output material ancestry id field data array {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
MaterialPropertiesName This the name of the input material property field data array {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
NonlinearSubdivisionLevel If the input is an unstructured grid with nonlinear faces, this parameter determines how many times the face is subdivided into linear faces. If 0, the output is the equivalent of its linear counterpart (and the midpoints determining the nonlinear interpolation are discarded). If 1, the nonlinear face is triangulated based on the midpoints. If greater than 1, the triangulated pieces are recursively subdivided to reach the desired subdivision. Setting the value to greater than 1 may cause some point data to not be passed even if no quadratic faces exist. This option has no effect if the input is not an unstructured grid. {"maximum":4,"minimum":0,"type":"integer"} native initialisation / omitted 0
PieceInvariant If the value of this property is set to 1, internal surfaces along process boundaries will be removed. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces. {"type":"boolean"} native initialisation / omitted false
RegionArrayName This property specifies the name of the material array for generating parts. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SingleSided If the value of this property is set to 1 (the default), surfaces along the boundary are 1 layer thick. Otherwise there is a surface for the material on each side. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractRegionSurface",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractSelection#

Extracts the points or cells described by a selection (Selection port, from one of the pv*SelectionSource operations or pvConvertSelection) from Input. By default the result is an unstructured grid holding only the selected elements (a table of selected rows for table input); with PreserveTopology it is a copy of the input with a vtkInsidedness array marking selected elements. Use it to isolate cells by ID, value, threshold, location, frustum or query.

Common mistakes and assumptions:

  • The selection's field type (CELL or POINT on the source) decides whether cells or points are extracted; a POINT selection without ContainingCells yields vertices only.
  • Selections built from IDs refer to the indices of the dataset they were made for; connect the same upstream data that the IDs came from.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractSelection. Identity: filters/ExtractSelection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Required data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input that provides the selection object. Accepted data: selections (vtkSelection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridToUnstructuredGrid Output an unstructured grid instead of a hyper tree grid (for input hyper tree grids). Should not be changed after first execution. {"type":"boolean"} native initialisation / omitted false
PreserveTopology If this property is set to 1 the output preserves the topology of its input and adds an insidedness array to mark which cells are inside or out. If 0 then the output is an unstructured grid which contains only the subset of cells that are inside. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractSelection",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Selection": "UPSTREAM_Selection"
  }
}

pvExtractSelectioninternal#

Internal ParaView variant of Extract Selection (vtkPVExtractSelection) with three output ports: 0 the extracted dataset, 1 a selection of the extracted point/cell indices, and 2 the input selection passed through; select a port with {"node": id, "port": n}. ParaView documents it as internal and recommends Extract Selection; use pvExtractSelection unless you need the index selection on port 1.

Common mistakes and assumptions:

  • Unlike pvExtractSelection it has no PreserveTopology option and accepts no table input.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractSelectioninternal. Identity: filters/PVExtractSelection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Required data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input that provides the selection object. Accepted data: selections (vtkSelection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridToUnstructuredGrid Output an unstructured grid instead of a hyper tree grid for input hyper tree grids. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractSelectioninternal",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Selection": "UPSTREAM_Selection"
  }
}

pvExtractSubset#

Extracts a sub-block of a structured dataset (image data, rectilinear or curvilinear grid) by point-index ranges in I, J and K, optionally keeping only every n-th index; the output has the same structured type. Use it to crop or coarsen a structured grid cheaply, e.g. one K-plane of a 3-D grid. Use extractSubset for the same operation with Schemaxis defaults (includeBoundary true).

Common mistakes and assumptions:

  • VOI uses point indices in the input's extent, which need not start at 0; check the input extent first.
  • With sample rates above 1 the last index is dropped unless IncludeBoundary is true.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractSubset. Identity: filters/ExtractGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Grid filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid); structured points (image data) (vtkStructuredPoints); curvilinear structured grids (vtkStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkRectilinearGrid","vtkStructuredPoints","vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
IncludeBoundary If the value of this property is 1, then if the sample rate in any dimension is greater than 1, the boundary indices of the input dataset will be passed to the output even if the boundary extent is not an even multiple of the sample rate in a given dimension. {"type":"boolean"} native initialisation / omitted false
SampleRateI This property indicates the sampling rate in the I dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"minimum":1,"type":"integer"} native initialisation / omitted 1
SampleRateJ This property indicates the sampling rate in the J dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"minimum":1,"type":"integer"} native initialisation / omitted 1
SampleRateK This property indicates the sampling rate in the K dimension. A value greater than 1 results in subsampling; every nth index will be included in the output. {"minimum":1,"type":"integer"} native initialisation / omitted 1
VOI This property specifies the minimum and maximum point indices along each of the I, J, and K axes; these values indicate the volume of interest (VOI). The output will have the (I,J,K) extent specified here. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractSubset",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractSubsetWithSeed#

From a structured grid (vtkStructuredGrid, including multiblock structured data split across blocks or processes), extracts the grid line (I, J or K) or grid surface (IJ, JK or KI) that passes through the cell containing Seed, following it across block boundaries even when block i-j-k origins differ. Typical use: pick a point to extract a wall-normal grid line or a constant-k surface of a curvilinear CFD mesh. Output keeps the structured cells, as a partitioned dataset for a single grid or the input's composite type otherwise.

Common mistakes and assumptions:

  • A seed outside every cell extracts nothing; place it inside the grid.
  • Only structured grids are accepted; use pvExtractSubset or extractSubset for index ranges of image or rectilinear data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractSubsetWithSeed. Identity: filters/ExtractSubsetWithSeed. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: curvilinear structured grids (vtkStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Direction Specify the direction in which to extract the slice starting with the Seed. {"type":"enum","values":["I","J","K","IJ","JK","KI"]} native initialisation / omitted "I"
Seed Specify the seed point in x-y-z coordinates to initiate in the slice extraction. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractSubsetWithSeed",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractSurface#

Extracts the outer surface of any dataset as polygonal data (vtkGeometryFilter): boundary faces of 3-D cells plus all lower-dimensional cells, with point and cell arrays carried over and internal faces removed. It is the same native filter as the curated surface operation, which has no options; choose pvExtractSurface to control nonlinear-face subdivision, fast mode, ghost-interface removal or piece invariance. For interfaces between materials use pvExtractRegionSurface.

Common mistakes and assumptions:

  • FastMode may miss faces, for example on blanked structured data; keep it off when the surface is measured or exported.
  • The outer surface of a CFD domain includes inlets, outlets and far-field boundaries, not only walls; extract the patches you need (extractBlock) when a specific boundary matters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractSurface. Identity: filters/DataSetSurfaceFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Extract Surface filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FastMode When enabled, the filter may use approxiamte algorithm for extracting the exterior surface at the risk not being highly accurate. This may miss interior faces, for example, for structured data with blanking for better speed. {"type":"boolean"} native initialisation / omitted false
NonlinearSubdivisionLevel If the input is an unstructured grid with nonlinear faces, this parameter determines how many times the face is subdivided into linear faces. If 0, the output is the equivalent of its linear counterpart (and the midpoints determining the nonlinear interpolation are discarded). If 1, the nonlinear face is triangulated based on the midpoints. If greater than 1, the triangulated pieces are recursively subdivided to reach the desired subdivision. Setting the value to greater than 1 may cause some point data to not be passed even if no quadratic faces exist. This option has no effect if the input is not an unstructured grid. {"maximum":4,"minimum":0,"type":"integer"} native initialisation / omitted 0
PieceInvariant If the value of this property is set to 1, internal surfaces along process boundaries will be removed. NOTE: Enabling this option might cause multiple executions of the data source because more information is needed to remove internal surfaces. {"type":"boolean"} native initialisation / omitted false
RemoveGhostInterfaces Set whether Ghost interfaces will be removed. When you are rendering you want to remove ghost interfaces. There are certain algorithms though that need the ghost interfaces. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractSurface",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvExtractTimeSteps#

Restricts a time-varying input to selected time steps, given as listed zero-based indices (Select Time Steps, ParaView default) or as an inclusive index range with a stride (Select Time Range). Downstream nodes see only those steps: a request for an unselected time is answered by a selected step chosen by ApproximationMode (Nearest Time Step by default), and times outside the selection get the first or last selected step. Use it to thin a long transient before temporalStatistics or pvParticlePath, or to hold a branch at one step.

Common mistakes and assumptions:

  • Indices are positions in the input's time list, not time values; indices beyond the last step are ignored without warning.
  • Scene times are still chosen by the Schemaxis times setting; this node only maps them onto the selected steps.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ExtractTimeSteps. Identity: filters/ExtractTimeSteps. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ApproximationMode If the scene's time does not match the time in any of the timesteps selected (likely because something else in the scene has time steps at different times) this setting controls which timestep should be returned by the filter. The options are the previous time step, the nearest time step and the next time step. {"type":"enum","values":["Previous Time Step","Next Time Step","Nearest Time Step"]} native initialisation / omitted "Previous Time Step"
SelectionMode Extract time steps supports two ways to select the time steps to be extracted: - Select Time Steps: Specify time steps to be extracted by their index - Select Time Range: Specify the start and end time steps of a range by their index and optionally specify a stride to optionally take every nth timestep in the range. {"type":"enum","values":["Select Time Steps","Select Time Range"]} native initialisation / omitted "Select Time Steps"
TimeStepIndices This property specifies the indices of the time steps to extract. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
TimeStepInterval Select the stride to use when extracting the range of time steps (the n in every nth timestep). {"minimum":1,"type":"integer"} native initialisation / omitted 1
TimeStepRange Select the beginning and end indices of the range of timesteps to extract. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvExtractTimeSteps",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvFDSReader#

Reads Fire Dynamics Simulator results through the Smokeview .smv file, which lists the other output files. The output is a partitioned dataset collection with five groups: Grids (meshes), Devices (point measurements over time), HRR (heat-release-rate tables), Slices and Boundaries (field data on planes and walls). AssemblySelectors chooses which of these are read. Use it for fire and smoke CFD from NIST FDS.

Common mistakes and assumptions:

  • Neither ParaView 5.13.3 nor vtkFDSReader defines default selectors, so an empty selection appears to read nothing; set AssemblySelectors explicitly, e.g. ["/"] for everything.
  • Keep the .smv file in the same folder as the files it lists; their paths are resolved relative to it.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: FDSReader. Identity: sources/FDSReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AssemblySelectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the file name for the VTKFDS reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFDSReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvFFTOfSelectionOverTime#

ParaView's compound filter that extracts the values of selected points or cells over all time steps (as Plot Selection Over Time does) and applies a discrete Fourier transform to each resulting time series (Table FFT), producing tables for spectral plots. Connect Input to the temporal dataset and Selection to a selection-source node (e.g. pvIDSelectionSource or pvLocationSelectionSource). Use it to find dominant frequencies of probe signals such as vortex shedding; use pvPlotSelectionOverTime and pvTableFFT separately when you need the frequency column or windowing.

Common mistakes and assumptions:

  • The compound definition disables the frequency column and uses a rectangular window and a two-sided spectrum, so rows are frequency bins without frequency labels.
  • Every time step of the input is executed; long series are slow, and uneven time spacing invalidates the FFT assumption of constant sampling.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FFTOfSelectionOverTime. Identity: filters/FFTSelectionOverTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Required data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 1,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFFTOfSelectionOverTime",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Selection": "UPSTREAM_Selection"
  }
}

pvFLASHAMRParticlesReader#

Reads particles from a FLASH HDF5 checkpoint or plot file into a multiblock dataset of polydata particle points with the selected particle arrays. Frequency keeps every N-th particle and FilterLocation keeps only particles inside a box. Use pvFlashReader for the grid fields of the same FLASH output.

Common mistakes and assumptions:

  • MaxLocation is the upper corner of the filter box, although ParaView's own documentation calls it the minimum.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FLASHAMRParticlesReader. Identity: sources/FlashParticlesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FilterLocation Turns on filtering of particles by location {"type":"boolean"} native initialisation / omitted false
Frequency This property sets the frequency interval for loading particles. {"type":"integer"} native initialisation / omitted 1
MaxLocation Upper corner [x, y, z] of the axis-aligned box used when FilterLocation is true: particles with any coordinate above it (or below MinLocation) are dropped. Coordinates are in the file's units. ParaView's own documentation calls this the minimum location; the reader uses it as the maximum. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
MinLocation This property sets the minimum 3-D coordinate location by which the particles will be filtered out. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ParticleArrayStatus Names of the particle arrays to read (for example particle_mass or velocity components); unlisted arrays are skipped, saving memory and time. Positions are always read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFLASHAMRParticlesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvFacetReader#

Reads a Facet file (.facet): a simple ASCII format listing point coordinates and the polygons connecting them, producing polygonal data. Use it for legacy surface geometry exported in this format; for common CAD exchange use readSTL or readPLY.

Common mistakes and assumptions:

  • Facet files carry no units; check the coordinate scale against other data.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: FacetReader. Identity: sources/FacetReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the Facet reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFacetReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvFastUniformGrid#

Synthetic source producing a 3-D uniform grid (image data) with cheap analytic point arrays: X (the x index, active scalars), optionally DistanceSquared (squared distance from the origin) and Swirl (the vector (y, z, x)). Use it for tests, benchmarks and demonstrations that need a predictable volume of adjustable size; use wavelet for a smoothly varying scalar field.

Common mistakes and assumptions:

  • Values are computed from index coordinates (unit spacing, origin at index 0); they are not physical quantities.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FastUniformGrid. Identity: sources/FastUniformGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DesiredBytesPerPiece The desired bytes per piece when the volume is split for SMP execution. When SMP is enabled, this is used to subdivide the volume into pieces. Smaller pieces allow for better dynamic load balancing, but increase the total overhead. {"type":"integer"} native initialisation / omitted 1
EnableSMP Enable/disable SMP for threading. {"type":"boolean"} native initialisation / omitted false
GenerateDistanceSquaredScalars Enable/disable DistanceSquared point data scalar array. {"type":"boolean"} native initialisation / omitted false
GenerateSwirlVectors Enable/disable Swirl point data vector array. {"type":"boolean"} native initialisation / omitted false
WholeExtent The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of -10, 10, -10, 10, =10, 10 indicate that the dimensions of the output will be 21 x 21 x 21. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFastUniformGrid"
}

pvFeatureEdges#

Full native Feature Edges: extracts boundary, feature, non-manifold and (optionally) manifold edges of a polygonal surface as polydata lines, with the same classes and ParaView defaults as featureEdges (boundary, feature and non-manifold on, manifold off, FeatureAngle 30°). It also exposes Coloring, which adds a cell array identifying each edge's class so the classes can be coloured or thresholded separately.

Common mistakes and assumptions:

  • Input must be polydata; extract the surface of volume meshes first.
  • Inconsistent normals or duplicate points produce spurious feature or boundary edges; run normals and clean first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FeatureEdges. Identity: filters/FeatureEdges. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Feature Edges filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundaryEdges If the value of this property is set to 1, boundary edges will be extracted. Boundary edges are defined as lines cells or edges that are used by only one polygon. {"type":"boolean"} native initialisation / omitted false
Coloring If the value of this property is set to 1, then the extracted edges are assigned a scalar value based on the type of the edge. {"type":"boolean"} native initialisation / omitted false
FeatureAngle The value of this property is used to define a feature edge. If the surface normal between two adjacent triangles is at least as large as this Feature Angle, a feature edge exists. (See the FeatureEdges property.) {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
FeatureEdges If the value of this property is set to 1, feature edges will be extracted. Feature edges are defined as edges that are used by two polygons whose dihedral angle is greater than the feature angle. (See the FeatureAngle property.) Toggle whether to extract feature edges. {"type":"boolean"} native initialisation / omitted false
ManifoldEdges If the value of this property is set to 1, manifold edges will be extracted. Manifold edges are defined as edges that are used by exactly two polygons. {"type":"boolean"} native initialisation / omitted false
NonManifoldEdges If the value of this property is set to 1, non-manifold edges will be extracted. Non-manifold edges are defined as edges that are use by three or more polygons. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFeatureEdges",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvFidesJSONReader#

Reads ADIOS2 data through Fides using an explicit Fides data model given as a JSON file, which describes how ADIOS2 variables form coordinates, cells and fields. The data model names one or more data sources, and DataSourcePath tells the reader which BP file or stream each source is. The output is a partitioned dataset collection. ParaView marks this route as mainly for debugging data models; use pvFidesReader when the BP output carries its own Fides metadata.

Common mistakes and assumptions:

  • Without a DataSourcePath for each source named in the JSON model nothing can be read; give the source name exactly as in the JSON.
  • ParaView's DataSourceIO is not exposed: it takes the memory address of a live ADIOS2 object, which Fides dereferences.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: FidesJSONReader. Identity: sources/FidesJSONReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ConverttoVTK Whether the data read by Fides are converted to native VTK datasets (true) or left in VTK-m form. Downstream ParaView filters generally need VTK datasets, so keep the default unless you know the following steps accept VTK-m data. {"type":"boolean"} native initialisation / omitted false
Createsharedpoints This property allows Fides to close gaps between blocks of structured grids by utilizing shared points. {"type":"boolean"} native initialisation / omitted false
DataSourceEngines Flat list of [source name, ADIOS2 engine] pairs choosing the engine used for each Fides data source, e.g. ["source", "BPFile"]. ADIOS2 engines include BP file engines and the SST staging engine; choosing SST switches the reader to streaming mode. Unlisted sources use the BP file engine. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
DataSourcePath Flat list of [source name, path] pairs telling the reader where each data source named in the JSON data model is: a BP file or directory for file engines, or a stream name for staging engines, e.g. ["source", "/data/run/output.bp"]. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder; absolute paths avoid ambiguity. The value must be a constant. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldArrays This property lists which field arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property sets the Fides JSON data model filename. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StreamSteps Reads the data as a stream, one step at a time as the writer releases it, instead of random access to all stored time steps. It is used for staging engines (SST) and BP5 streaming, and is switched on automatically when an SST engine is set. {"type":"boolean"} native initialisation / omitted false

onVisit commands:

{
  "PrepareNextStep": {
    "command": "PrepareNextStep",
    "native": "PrepareNextStep"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "DataSourceIO": "in-process memory address that the native reader dereferences; unsafe for authored input"
  },
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFidesJSONReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["PrepareNextStep"]. Commands run in this authored order before the update.

pvFidesReader#

Reads ADIOS2 output through the Fides library, which maps ADIOS2 variables to meshes using a data model; for a BP file or BP4/BP5 directory written with Fides metadata the data model is found automatically. The output is a partitioned dataset collection with the selected point, cell and field arrays and the stored time steps. Use it for Fides-annotated simulation output; use pvFidesJSONReader when the data model is a separate JSON file.

Common mistakes and assumptions:

  • Array selections are made from names found in the file; list the arrays you need, because ParaView chooses the initial selection.
  • Streaming (StreamSteps, SST engines) is for in-situ coupling; leave it unset for files on disk. ParaView's DataSourceIO is not exposed because it takes the memory address of a live ADIOS2 object, which Fides dereferences and which is meaningless outside a co-resident simulation.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: FidesReader. Identity: sources/FidesFileReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ConvertToVTK This property determines whether data should be converted to VTK or stay in VTK-m format. {"type":"boolean"} native initialisation / omitted false
Createsharedpoints This property allows Fides to close gaps between blocks of structured grids by utilizing shared points. {"type":"boolean"} native initialisation / omitted false
DataSourceEngines Flat list of [source name, ADIOS2 engine] pairs choosing the engine used for each Fides data source, e.g. ["source", "BPFile"]. ADIOS2 engines include BP file engines and the SST staging engine; choosing SST switches the reader to streaming mode. Unlisted sources use the BP file engine. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldArrays This property lists which field arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property sets the ADIOS2 bp filename for Fides to read. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StreamSteps Reads the data as a stream, one step at a time as the writer releases it, instead of random access to all stored time steps. It is used for staging engines (SST) and BP5 streaming, and is switched on automatically when an SST engine is set. {"type":"boolean"} native initialisation / omitted false

onVisit commands:

{
  "PrepareNextStep": {
    "command": "PrepareNextStep",
    "native": "PrepareNextStep"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "DataSourceIO": "in-process memory address that the native reader dereferences; unsafe for authored input"
  },
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFidesReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["PrepareNextStep"]. Commands run in this authored order before the update.

pvFieldArraysFromFile#

Passes its input through unchanged and attaches the field-data arrays found in a legacy VTK file (.vtk, read with vtkDataObjectReader, e.g. a file holding a FIELD section); on a composite input every block receives them. Only field data (whole-dataset values such as run parameters, metadata or small history tables) is added, never point or cell arrays. Use it to carry case metadata alongside a mesh; for per-point or per-cell values join data with another operation instead.

Common mistakes and assumptions:

  • The file must be a legacy .vtk data file; XML VTK files are not read by this filter.
  • An added array replaces an existing field array of the same name.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FieldArraysFromFile. Identity: filters/FieldArraysFromFile. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file to read to get arrays Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

onVisit commands:

{
  "Reload": {
    "command": "Modified",
    "native": "Reload"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFieldArraysFromFile",
  "inputs": {
    "Input": "UPSTREAM_Input"
  },
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["Reload"]. Commands run in this authored order before the update.

pvFieldDatatoAttribute#

Copies field-data arrays (one value per dataset, e.g. a time value or a parameter stored by a reader) into point or cell arrays holding that value at every point or cell. Only the first component of the first tuple is used, stored as a constant (implicit) array, so the memory cost is small; string arrays are not supported. Use it to colour, threshold or calculate with dataset-level values alongside the fields.

Common mistakes and assumptions:

  • Multi-component or multi-value field arrays are reduced to their first value.
  • OutputFieldType is chosen by the ParaView entry text ("Point Data", "Cell Data", "Vertex Data", "Edge Data" or "Row Data"); ParaView offers only the associations the connected input has.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FieldDatatoAttribute. Identity: filters/FieldDataToDataSetAttribute. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of this filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one field-data array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FieldDataArrays Add a field array by name to be converted. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
OutputFieldType Attribute type that receives the converted field-data arrays. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data" or "Row Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data"]} native initialisation / omitted "Point Data"
ProcessAllArrays The value of this property controls whether all input field arrays will be processed and converted. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFieldDatatoAttribute",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvFiniteElementFieldDistributor#

Turns element-wise finite-element coefficients into point fields for visualization: it duplicates points so each element owns its own nodes, promotes cells to higher-order Lagrange types where needed, and evaluates H(Grad) discontinuous-Galerkin scalars and H(Curl)/H(Div) vector fields at those nodes. Input must be a partitioned dataset collection whose field data has an "Information Records" string array describing bases and fields (Intrepid2 conventions, e.g. Exodus files read with the IOSS reader); the output has the same structure with the distributed point arrays.

Common mistakes and assumptions:

  • Without a valid Information Records array the filter fails; ordinary meshes are not suitable.
  • Pyramid elements are not supported, and the duplicated points make the output larger than the input.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FiniteElementFieldDistributor. Identity: filters/FiniteElementFieldDistributor. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Finite Element Field Distributor filter. The input dataset must have an Information Records string array in the field data. Accepted data: partitioned dataset collections (vtkPartitionedDataSetCollection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPartitionedDataSetCollection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFiniteElementFieldDistributor",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvFlashReader#

Reads output of the FLASH astrophysics code (HDF5 plot or checkpoint files) into an overlapping AMR (hierarchical box) dataset: nested refinement levels of uniform blocks with cell-centred variables. Level sets the finest level loaded, counted from the root level 0 (ParaView default 1), and every variable starts disabled, so name the ones you need in CellArrayStatus. Several files form a time series. For particles use pvFLASHAMRParticlesReader; to analyse on a uniform grid, follow with pvResampleToImage or pvResampleAMR.

Common mistakes and assumptions:

  • The native help text says this reader loads 'Enzo format'; that is a copy error in the ParaView XML. It reads FLASH files; use pvEnzoReader for Enzo.
  • Level 1 shows only the two coarsest levels; raise it (up to the file's level count) before measuring fine-scale features, accepting more memory.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FlashReader. Identity: sources/FlashReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred variables to load from the FLASH file, such as density or pressure fields. Listing names loads exactly those arrays and disables every other array the file offers; an empty list loads none. Fewer arrays mean less memory and faster reads. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EnableCaching Keep AMR blocks that have already been read in memory, so later updates that change the level or array selection, or revisit a time, do not reread them from disk. It does not change the data produced. {"type":"boolean"} native initialisation / omitted false
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Level This property specifies the desired level of resolution that will be visible. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus Names of point-centred arrays to load. This reader lists only cell-centred variables from the file (its array setup registers cell arrays only), so there is normally nothing to select here; use CellArrayStatus and convert with cellToPoint if you need point data. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFlashReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvFluentCFFCaseReader#

Reads ANSYS Fluent results in the HDF5-based Common Fluids Format: the case file (.cas.h5) and, automatically, the data file of the same name (.dat.h5). The output is a multiblock dataset of unstructured grids with cell-centred solution fields. Several case files form a time series. Use pvFluentCaseReader for the legacy .cas/.dat format.

Common mistakes and assumptions:

  • If the matching .dat.h5 is missing, only the mesh is read (VTK warns); keep both files together with the same base name.
  • Fields are cell data; use cellToPoint before operations that need point data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: FluentCFFCaseReader. Identity: sources/FLUENTCFFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred solution fields to read from the .dat.h5 file (for example pressure, velocity or temperature as named by Fluent). Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The name of the files to load. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFluentCFFCaseReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvFluentCaseReader#

Reads ANSYS Fluent legacy case files (.cas, or .msh mesh files) and the data file whose name replaces the extension with .dat, producing a multiblock dataset of unstructured grids with cell-centred fields. Several case files form a time series. Use pvFluentCFFCaseReader for the HDF5-based .cas.h5/.dat.h5 format.

Common mistakes and assumptions:

  • The data file must sit beside the case file with the same base name (run.cas and run.dat).
  • Fields are cell data; use cellToPoint before operations that need point data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: FluentCaseReader. Identity: sources/FLUENTReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred solution fields to read from the .dat file, as the reader lists them for the case. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The name of the files to load. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFluentCaseReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvForceStaticMesh#

Caches the geometry and topology of its input the first time it runs and keeps reusing that mesh for later time steps, updating only point, cell and field data while the point and cell counts stay the same. Use it after readers or filters that rebuild an unchanged mesh at every time step, so that downstream work depending only on the mesh need not be repeated. It handles an unstructured grid, polydata, or the first block of a composite input when that block is an unstructured grid.

Common mistakes and assumptions:

  • If the mesh really moves or is remeshed with the same counts, the cached geometry is wrong, and ParaView 5.13.3 offers no way to force the cache to recompute: ForceCacheComputation has no elements, so invoking it sends no message, and assigning it pushes the XML command SetCacheComputation, which vtkForceStaticMesh lacks (it has SetForceCacheComputation) and which aborts the native process. Schemaxis therefore does not expose it. Use a different filter chain for meshes that change.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ForceStaticMesh. Identity: filters/ForceStaticMesh. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: unstructured grids (vtkUnstructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid","vtkPolyData","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "ForceCacheComputation": "zero-element property with no usable native command"
  },
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvForceStaticMesh",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvForceTime#

Makes its output use one fixed time, ForcedTime (ParaView default 0.0), whatever time the scene requests: the upstream pipeline is updated once at ForcedTime, the result is cached, and every time step it reports is replaced by ForcedTime. Use it to hold a reference state, such as the initial geometry or a chosen snapshot, fixed while the rest of the scene follows the selected times. With IgnorePipelineTime false it passes the input through unchanged.

Common mistakes and assumptions:

  • ForcedTime is a time value in the input's units, not an index; use a stored time, because how a time between stored steps is served is decided by the upstream reader.
  • ParaView's static ForcedTime is 0.0; set it explicitly when the case does not start at 0.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ForceTime. Identity: filters/ForceTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the ForceTime filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ForcedTime This property specifies the time to request. If the IgnorePipelineTime property is set, then this value will override any time request in the VTK pipeline. {"type":"number"} native initialisation / omitted 1
IgnorePipelineTime If set to 0, this filter will do nothing, only shallow copy the input to the output. If set to 1, this filter will always request the ForcedTime to the pipeline, ignoring time requests. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvForceTime",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvFrustumSelectionSource#

Creates a frustum selection: everything inside a convex volume bounded by six planes, given by the eight corner vertices in Frustum. This is how ParaView stores a rubber-band selection through a camera view, but any convex hexahedral region (e.g. a box) can be described. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. For an axis-aligned box clip, pvClip with a Box type is often simpler.

Common mistakes and assumptions:

  • Corner order matters: swapping near and far faces turns the planes inside out and selects nothing.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: FrustumSelectionSource. Identity: sources/FrustumSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
Frustum Vertices that define a frustum for the selection source. {"items":{"type":"number"},"maxItems":32,"minItems":32,"type":"array"} native initialisation / omitted [1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1]
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvFrustumSelectionSource"
}

pvGDALRasterReader#

Reads a GIS raster (GeoTIFF, DEM, ERDAS and the other formats supported by GDAL) into a uniform grid (vtkUniformGrid, supporting blanking of no-data pixels) whose bands are cell-data arrays, one cell per raster pixel. Colour bands are by default collated into one RGB, RGBA, grey-alpha or palette array. Use it for terrain heights, satellite images or land-use maps; warp a height band with warpScalar to obtain terrain.

Common mistakes and assumptions:

  • Band values are cell data; run cellToPoint before operations that need point data, such as warping by a height band.
  • Coordinates are in the raster's projection units; nothing is reprojected.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: GDALRasterReader. Identity: sources/GDALRasterReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Sets which GDAL bands to load from the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CollateBands Sets if bands are collated in one scalar array or not. Currently we collate bands into RGB, RGBA, gray alpha and pallete. The default is true. {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the file name for the GDAL Raster reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
TargetDimensions Set the desired width and height of the image. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGDALRasterReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvGDALVectorReader#

Reads one layer of a GIS vector file (Shapefile, GeoJSON, KML, GML, DXF and other GDAL vector formats) into polydata: points, lines and polygons with the feature attributes as cell-data arrays. By ParaView default each feature is a separate block of a multiblock dataset; AppendFeatures merges them into one polydata. Use it for outlines, roads, building footprints or measurement locations in GIS formats.

Common mistakes and assumptions:

  • Only ActiveLayer (default 0, the first layer) is read; create one node per layer when a file has several.
  • Coordinates are in the file's coordinate reference system; nothing is reprojected.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: GDALVectorReader. Identity: sources/GDALVectorReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ActiveLayer Zero-based index of the layer to read from a multi-layer GDAL vector source (for example one table of a GeoPackage or one layer of a shapefile directory). Only this layer is read unless AppendFeatures combines all layers. {"type":"integer"} native initialisation / omitted 1
AddFeatureIds Set whether feature IDs should be generated. Some GDAL primitives (e.g., a polygon with a hole in its interior) are represented by multiple VTK cells. If you wish to identify the primitive responsible for a VTK cell, turn this on. It is off by default for backwards compatibility. The array of feature IDs will be the active cell-data pedigree IDs. {"type":"boolean"} native initialisation / omitted false
AppendFeatures Set whether features are appended to a single vtkPolyData. Turning the option on is useful when a shapefile has a number of features which could otherwise lead to a huge multiblock structure. {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the file name for the GDAL Vector reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGDALVectorReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvGaussianCubeReader#

Reads a Gaussian Cube file (.cube) produced by the Gaussian quantum-chemistry package. Output port 0 is the molecule (vtkMolecule: atoms and positions) and port 1 the gridded volumetric quantity, such as electron density or an orbital, as image data; select it with {"node": id, "port": 1} for contouring or volume rendering. Use pvXYZReader or pvPDBReader for structures without volumetric data.

Common mistakes and assumptions:

  • Port 0 is a vtkMolecule, not a dataset; most filters need the gridded data on port 1 or pvMoleculeToLines first.
  • Cube files normally use bohr units; nothing is converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: GaussianCubeReader. Identity: sources/gaussiancubereader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the Gaussian Cube reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGaussianCubeReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvGaussianResampling#

Splats the input points into a uniform volume (vtkImageData, point array SplatterValues): each point adds a Gaussian kernel ScaleFactor × value × exp(ExponentFactor × r² / R²) to nearby voxels within radius R, and overlapping contributions are combined by the accumulation mode (ParaView default Max). Without a selected array, or with scale splats off, each point contributes the kernel alone, giving a smooth point-density field. Use it to turn scattered particles or measurements into a continuous field for contouring or volume rendering; use pvResampleToImage to sample an existing mesh instead.

Common mistakes and assumptions:

  • The default 50 × 50 × 50 grid can be too coarse or too costly; choose ResamplingGrid deliberately, because time grows with the voxel count.
  • Fill Volume Boundary (on by default) overwrites the outer layer of voxels with Fill Value, which can create artificial contours at the box faces.
  • Points cannot splat into other processes' regions, so MPI results can differ near partition boundaries. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GaussianResampling. Identity: filters/GaussianSplatter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
EllipiticalEccentricity Control the shape of elliptical splatting. Eccentricity is the ratio of the major axis (aligned along normal) to the minor (axes) aligned along other two axes. So Eccentricity gt 1 creates needles with the long axis in the direction of the normal; Eccentricity lt 1 creates pancakes perpendicular to the normal vector. {"type":"number"} native initialisation / omitted 1
EllipticalSplats Turn on/off the generation of elliptical splats. If normal warping is on, then the input normals affect the distribution of the splat. This boolean is used in combination with the Eccentricity ivar. {"type":"boolean"} native initialisation / omitted false
EmptyCellValue Set the Null value for output points not receiving a contribution from the input points. (This is the initial value of the voxel samples.) {"type":"number"} native initialisation / omitted 1
ExtenttoResample Set / get the (xmin,xmax, ymin,ymax, zmin,zmax) bounding box in which the sampling is performed. If any of the (min,max) bounds values are min >= max, then the bounds will be computed automatically from the input data. Otherwise, the user-specified bounds will be used. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
FillValue Specify the cap value to use. (This instance variable only has effect if the ivar Capping is on.) {"type":"number"} native initialisation / omitted 1
FillVolumeBoundary Turn on/off the capping of the outer boundary of the volume to a specified cap value. This can be used to close surfaces (after isosurfacing) and create other effects. {"type":"boolean"} native initialisation / omitted false
GaussianExponentFactor Set / get the sharpness of decay of the splats. This is the exponent constant in the Gaussian equation. Normally this is a negative value. {"maximum":0.0,"type":"number"} native initialisation / omitted 1
GaussianSplatRadius Radius of influence of each splat as a fraction of the longest side of the sampling box: 0.1 means 10 % of that length. Voxels farther away receive nothing; larger values give smoother, more overlapping fields and longer run times. {"type":"number"} native initialisation / omitted 1
ResampleField Choose a scalar array to splat into the output cells. If ignore arrays is chosen, point density will be counted instead. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ResamplingGrid Set / get the dimensions of the sampling structured point set. Higher values produce better results but are much slower. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ScaleFactor Multiply Gaussian splat distribution by this value. If ScalarWarping is on, then the Scalar value will be multiplied by the ScaleFactor times the Gaussian function. {"type":"number"} native initialisation / omitted 1
ScaleSplats Turn on/off the scaling of splats by scalar value. {"type":"boolean"} native initialisation / omitted false
SplatAccumulationMode Specify the scalar accumulation mode. This mode expresses how scalar values are combined when splats are overlapped. The Max mode acts like a set union operation and is the most commonly used; the Min mode acts like a set intersection, and the sum is just weird. {"type":"enum","values":["Min","Max","Sum"]} native initialisation / omitted "Min"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGaussianResampling",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateGlobalIds#

Deprecated alias of pvGlobalPointAndCellIds (renamed in ParaView 5.13, removal planned for 5.14): generates global point and cell ids consistent across blocks and processes and flags duplicated points as ghosts. Prefer pvGlobalPointAndCellIds for new workflows.

Common mistakes and assumptions:

  • Expect this operation to disappear when Schemaxis absorbs ParaView 5.14.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateGlobalIds. Identity: filters/GenerateGlobalIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Tolerance Set the tolerance to use to identify coincident points. 0 means the points should be exactly identical. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateGlobalIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateIds#

Deprecated alias of pvPointAndCellIds: ParaView 5.13 marks GenerateIdScalars for removal in 5.14, and it still runs the older vtkIdFilter. It adds zero-based point indices (PointIds) and cell indices (CellIds) as point and cell arrays. Use pvPointAndCellIds or generateIds in new workflows.

Common mistakes and assumptions:

  • This identifier is expected to disappear when ParaView 5.14 is absorbed.
  • Ids restart in every block and MPI piece; use pvGlobalPointAndCellIds for global ids.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateIds. Identity: filters/GenerateIdScalars. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Data to Point Data filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellIdsArrayName The name of the cell ids array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
GenerateCellIds Enable generation of cell ids. {"type":"boolean"} native initialisation / omitted false
GeneratePointIds Enable generation of point ids. {"type":"boolean"} native initialisation / omitted false
PointIdsArrayName The name of the point ids array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateProcessIds#

Deprecated alias of pvProcessIds (ParaView marks GenerateProcessIds deprecated in 5.13, to be removed in 5.14): it adds PointProcessIds and/or CellProcessIds arrays giving the owning MPI process of each point or cell. Prefer pvProcessIds for new workflows; behaviour is the same.

Common mistakes and assumptions:

  • Expect this operation to disappear when Schemaxis absorbs ParaView 5.14.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateProcessIds. Identity: filters/GenerateProcessIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateCellData The value of this property determines whether to generate process id for cells. {"type":"boolean"} native initialisation / omitted false
GeneratePointData The value of this property determines whether to generate process id for points. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateProcessIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateQuadraturePoints#

Creates a point cloud (polydata with one vertex per quadrature point) from the selected quadrature offset array, carrying as point data the field-data arrays previously interpolated to the same offsets. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud. Use it to view or export quadrature-point values, e.g. for finite-element verification.

Common mistakes and assumptions:

  • Only field arrays linked to the selected offset array are carried; run pvInterpolatetoQuadraturePoints with the same offset array first.
  • A missing dictionary yields an empty output with only a logged error.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateQuadraturePoints. Identity: filters/QuadraturePointsGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
QuadratureSchemeDef Specifies the offset array from which we generate quadrature points. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 1,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateQuadraturePoints",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateQuadratureSchemeDictionary#

Adds a cell array QuadratureOffset (one offset per cell) whose metadata holds a quadrature-rule dictionary for each cell type, the starting point of ParaView's quadrature workflow. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud. Rules exist only for triangles, quadratic triangles, pixels, quads, quadratic quads, tetrahedra and quadratic tetrahedra.

Common mistakes and assumptions:

  • Hexahedra, wedges, pyramids and polyhedra are unsupported; the offset array is then left unfilled without a pipeline error.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateQuadratureSchemeDictionary. Identity: filters/QuadratureSchemeDictionaryGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateQuadratureSchemeDictionary",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateSpatioTemporalHarmonics#

Adds a point array SpatioTemporalHarmonics (set as active scalars) whose value at point x and time t is the sum over harmonics of A·sin(k·x + ω·t + φ), with t the requested pipeline time and x in dataset coordinates. It produces analytic, time-varying test fields, e.g. to check interpolation, temporal statistics or FFT workflows against known waves. This is the old name of the same ParaView filter.

Common mistakes and assumptions:

  • ParaView 5.13 marks this proxy deprecated (renamed SpatioTemporalHarmonics, removal planned for 5.14); use pvSpatioTemporalHarmonics, which has the same behaviour and settings.
  • The ParaView default harmonics are examples sized for bounds [-10, 10] and times in [0, 2π); give your own for other domains.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateSpatioTemporalHarmonics. Identity: filters/GenerateSpatioTemporalHarmonics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Harmonics This property defines the harmonics that will be computed and summed on each point. Default values are only example values, that would make sense for a dataset of geometrical bounds [-10,10,-10,10,-10,10] and time values greater than or equal to 0 and less than 2*Pi. Complete tuples of 6 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateSpatioTemporalHarmonics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateSurfaceNormals#

Deprecated ParaView alias of pvSurfaceNormals: the PolyDataNormals proxy was renamed SurfaceNormals, deprecated in ParaView 5.13 and is scheduled for removal in 5.14. It computes point normals on polygonal surfaces for smooth shading, with exactly the settings and behaviour of pvSurfaceNormals. Prefer pvSurfaceNormals in new documents.

Common mistakes and assumptions:

  • Documents using this operation will need migration to pvSurfaceNormals when ParaView 5.14 is absorbed.
  • Input must be polydata; extract a surface (surface) from volume meshes first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateSurfaceNormals. Identity: filters/PolyDataNormals. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Normals Generation filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeCellNormals This filter computes the normals at the points in the data set. In the process of doing this it computes polygon normals too. If you want these normals to be passed to the output of this filter, set the value of this property to 1. {"type":"boolean"} native initialisation / omitted false
Consistency The value of this property controls whether consistent polygon ordering is enforced. Generally the normals for a data set should either all point inward or all point outward. If the value of this property is 1, then this filter will reorder the points of cells that whose normal vectors are oriented the opposite direction from the rest of those in the data set. {"type":"boolean"} native initialisation / omitted false
FeatureAngle The value of this property defines a feature edge. If the surface normal between two adjacent triangles is at least as large as this Feature Angle, a feature edge exists. If Splitting is on, points are duplicated along these feature edges. (See the Splitting property.) {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
FlipNormals If the value of this property is 1, this filter will reverse the normal direction (and reorder the points accordingly) for all polygons in the data set; this changes front-facing polygons to back-facing ones, and vice versa. You might want to do this if your viewing position will be inside the data set instead of outside of it. {"type":"boolean"} native initialisation / omitted false
NonManifoldTraversal Turn on/off traversal across non-manifold edges. Not traversing non-manifold edges will prevent problems where the consistency of polygonal ordering is corrupted due to topological loops. {"type":"boolean"} native initialisation / omitted false
PieceInvariant Turn this option to to produce the same results regardless of the number of processors used (i.e., avoid seams along processor boundaries). Turn this off if you do want to process ghost levels and do not mind seams. {"type":"boolean"} native initialisation / omitted false
Splitting This property controls the splitting of sharp edges. If sharp edges are split (property value = 1), then points are duplicated along these edges, and separate normals are computed for both sets of points to give crisp (rendered) surface definition. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateSurfaceNormals",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateSurfaceTangents#

Deprecated alias of pvSurfaceTangents: ParaView 5.13 marks PolyDataTangents for removal in 5.14. It computes point tangents (array Tangents) of a triangulated surface from point normals and texture coordinates for normal-map rendering.

Common mistakes and assumptions:

  • Use pvSurfaceTangents in new workflows; this identifier is expected to disappear when ParaView 5.14 is absorbed.
  • Input needs point normals and texture coordinates on triangles.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateSurfaceTangents. Identity: filters/PolyDataTangents. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Tangents Generation filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeCellTangents This filter computes the tangents at the points in the data set. In the process of doing this it computes polygon tangents too. If you want these normals to be passed to the output of this filter, set the value of this property to 1. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateSurfaceTangents",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenerateTimeSteps#

Passes its input through unchanged (shallow copy) but declares a new list of time steps (TimeStepValues), ignoring any time steps the input reports. Use it to give static or untimed data a time axis, so temporal filters or time-dependent scenes downstream have steps to work with. It only relabels: a request for one of the new times is passed upstream unchanged, so static input returns the same data at every step and nothing is interpolated.

Common mistakes and assumptions:

  • To create intermediate states of genuinely transient data use pvTemporalInterpolator instead.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenerateTimeSteps. Identity: filters/GenerateTimeSteps. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
TimeStepValues This property specifies the timestep values to generate. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenerateTimeSteps",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGenericIOMultiBlockReader#

Reads HACC GenericIO particle files (.gio) into a multiblock dataset with one unstructured-grid block per block stored in the file (usually one per writing MPI rank), vtkPGenericIOMultiBlockReader. Coordinate, array and halo settings work as in pvGenericIOReader. Choose it to keep the file's decomposition, for example to read back pvWriteGenericIOWriter output; use pvGenericIOReader for a single particle grid.

Common mistakes and assumptions:

  • The underlying reader class defaults the coordinate names to x, y and z, but ParaView may replace them from the file; set xAxis, yAxis and zAxis explicitly.
  • ParaView marks the GenericIO readers mpi_required; Schemaxis's serial writer fixture read a GenericIO file successfully with pvGenericIOMultiBlockReader, but other files are unverified.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenericIOMultiBlockReader. Identity: sources/GenericIOMultiBlockReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BlockAssignmentStrategy Method used to assign blocks to processes. {"type":"enum","values":["RoundRobin","RCB (contiguous)"]} native initialisation / omitted "RoundRobin"
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
HaloId Which data array in the file contains the halo ids. This is used with the halo ids to load to determine which points to load. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
HalosToLoad Only load in points with these halo ids from the file. If no halo ids are specified, load all the points. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
PointArrayStatus Names of the GenericIO variables to load as point arrays on the particles (for example vx, vy, vz, id, fof_halo_tag). Unlisted variables are not read, which saves memory; the coordinate variables named by xAxis, yAxis and zAxis are always read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ReadMethod Method used for reading, either MPI or POSIX is used. {"type":"enum","values":["MPI","Posix"]} native initialisation / omitted "MPI"
xAxis Name of the GenericIO variable used as the first (x) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
yAxis Name of the GenericIO variable used as the second (y) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
zAxis Name of the GenericIO variable used as the third (z) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenericIOMultiBlockReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvGenericIOReader#

Reads HACC GenericIO particle files (.gio) into one unstructured grid of particles (vtkPGenericIOReader): xAxis, yAxis and zAxis name the coordinate variables, PointArrayStatus chooses the other variables to load, and HalosToLoad with HaloId can restrict reading to particles of chosen halos. Several file names form a time series. Its output suits pvANLHaloFinder; use pvGenericIOMultiBlockReader to keep the file's blocks separate and pvMultiResGenericIO for multi-resolution .gios sets.

Common mistakes and assumptions:

  • Set xAxis, yAxis and zAxis; without valid coordinate variables no points are produced.
  • ParaView marks the GenericIO readers mpi_required; Schemaxis's serial writer fixture read a GenericIO file successfully with pvGenericIOMultiBlockReader, but other files are unverified.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GenericIOReader. Identity: sources/GenericIOReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BlockAssignmentStrategy Method used to assign blocks to processes. {"type":"enum","values":["RoundRobin","RCB (contiguous)"]} native initialisation / omitted "RoundRobin"
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
HaloId Which data array in the file contains the halo ids. This is used with the halo ids to load to determine which points to load. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
HalosToLoad Only load in points with these halo ids from the file. If no halo ids are specified, load all the points. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
PointArrayStatus Names of the GenericIO variables to load as point arrays on the particles (for example vx, vy, vz, id, fof_halo_tag). Unlisted variables are not read, which saves memory; the coordinate variables named by xAxis, yAxis and zAxis are always read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
QueryRankNeighbors If checked, only the data of the RankInQuery and its neighbors will be rendered. {"type":"boolean"} native initialisation / omitted false
RankInQuery Used in combination with QueryRankNeighbors, this property tells the reader to only render the data of this rank and its neighbors. {"type":"integer"} native initialisation / omitted 1
ReadMethod Method used for reading, either MPI or POSIX is used. {"type":"enum","values":["MPI","Posix"]} native initialisation / omitted "MPI"
xAxis Name of the GenericIO variable used as the first (x) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
yAxis Name of the GenericIO variable used as the second (y) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
zAxis Name of the GenericIO variable used as the third (z) particle coordinate. All three coordinate variables must exist in the file, otherwise the reader reports missing coordinate arrays and produces no points. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGenericIOReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvGeometryFilter#

ParaView's rendering geometry extractor (vtkPVGeometryFilter): converts any dataset, including composite and nonlinear-cell data, into polydata of its outer surface or, with UseOutline, its bounding outline, adding original cell and point id arrays by default. Representations use it internally; as a pipeline node it is a robust way to get the renderable surface. For an ordinary surface use surface or pvExtractSurface.

Common mistakes and assumptions:

  • Interior faces are not produced; slice or clip first to see inside a volume.
  • Higher NonlinearSubdivisionLevel values multiply the polygon count exponentially.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GeometryFilter. Identity: filters/GeometryFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Geometry Filter. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NonlinearSubdivisionLevel Nonlinear faces are approximated with flat polygons. This parameter controls how many times to subdivide nonlinear surface cells. Higher subdivisions generate closer approximations but take more memory and rendering time. Subdivision is recursive, so the number of output polygons can grow exponentially with this parameter. {"maximum":4,"minimum":0,"type":"integer"} native initialisation / omitted 0
PassThroughIds If on, the output polygonal dataset will have a cell data array that holds the cell index of the original 3D cell that produced each output cell. This is useful for cell picking. {"type":"boolean"} native initialisation / omitted false
PassThroughPointIds If on, the output polygonal dataset will have a point data array that holds the point index of the original 3D vertex that produced each output vertex. This is useful for picking. {"type":"boolean"} native initialisation / omitted false
UseOutline Toggle whether to generate an outline or a surface. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGeometryFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGhostCells#

Generates ghost cells and points: layers of neighbouring cells copied from adjacent blocks of a partitioned dataset or from other MPI processes, marked with vtkGhostType. Supported block types are image, rectilinear, structured, polydata and unstructured grids (and hyper tree grids). Use it before filters that need neighbour information across partition boundaries, such as gradients or smoothing, so results do not show seams; remove the layers afterwards with pvRemoveGhostInformation.

Common mistakes and assumptions:

  • Ghosts are exchanged only between partitions of the same partitioned dataset, not between different datasets of a collection.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GhostCells. Identity: filters/GhostCells. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BuildIfRequired Specify if the filter must generate the ghost cells only if required by the pipeline downstream. To force at least a fixed level of ghosts, this must be set to 0 (unchecked). {"type":"boolean"} native initialisation / omitted false
GenerateGlobalIds Specify if the filter should generate global ids when generating ghost cells. {"type":"boolean"} native initialisation / omitted false
GenerateProcessIds Specify if the filter should generate process ids when generating ghost cells. {"type":"boolean"} native initialisation / omitted false
MinimumNumberOfGhosts When BuildIfRequired if off, use this to specify the minimum number of ghost cells to request. The filter may request more ghost levels than indicated if a downstream filter asked for more ghost levels. {"maximum":100,"minimum":0,"type":"integer"} native initialisation / omitted 0
SynchronizeOnly Specify if the filter should only try to synchronize ghost data. If On, it assumes the number of ghost layer should not change. If On, but conditions are not met (ghosts, gids and pids), it will fallback on the default behavior: generating ghosts. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGhostCells",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGhostCellsGenerator#

Deprecated alias of pvGhostCells (renamed in ParaView 5.13, removal planned for 5.15): generates ghost cell and point layers between partitions and processes. Prefer pvGhostCells for new workflows; the settings are identical.

Common mistakes and assumptions:

  • Expect this operation to disappear in a later ParaView absorption.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GhostCellsGenerator. Identity: filters/GhostCellsGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BuildIfRequired Specify if the filter must generate the ghost cells only if required by the pipeline downstream. To force at least a fixed level of ghosts, this must be set to 0 (unchecked). {"type":"boolean"} native initialisation / omitted false
GenerateGlobalIds Specify if the filter should generate global ids when generating ghost cells. {"type":"boolean"} native initialisation / omitted false
GenerateProcessIds Specify if the filter should generate process ids when generating ghost cells. {"type":"boolean"} native initialisation / omitted false
MinimumNumberOfGhosts When BuildIfRequired if off, use this to specify the minimum number of ghost cells to request. The filter may request more ghost levels than indicated if a downstream filter asked for more ghost levels. {"maximum":100,"minimum":0,"type":"integer"} native initialisation / omitted 0
SynchronizeOnly Specify if the filter should only try to synchronize ghost data. If On, it assumes the number of ghost layer should not change. If On, but conditions are not met (ghosts, gids and pids), it will fallback on the default behavior: generating ghosts. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGhostCellsGenerator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGlobalIDSelectionSource#

Creates a selection by global ID: the elements whose value in the input's designated global-ID array (point or cell, per FieldType) equals one of GlobalIDs. Global IDs stay the same across MPI decompositions and across composite blocks, so this is the robust way to pick the same nodes or elements in a partitioned mesh. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvIDSelectionSource for plain zero-based indices.

Common mistakes and assumptions:

  • The input must carry a global-ID attribute array (e.g. written by the solver, or generated with pvGlobalPointAndCellIds); an ordinary integer array named "GlobalIds" that is not flagged as global IDs is not used.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GlobalIDSelectionSource. Identity: sources/GlobalIDSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
GlobalIDs The list of IDs that will be added to the selection produced by the selection source. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGlobalIDSelectionSource"
}

pvGlobalPointAndCellIds#

Assigns global point and cell ids that are unique across all blocks and MPI processes, giving the same id to points duplicated at block or process boundaries (matched within Tolerance) and marking the duplicates as ghost points. Hyper tree grids get cell ids only. Use it before operations that need consistent ids across partitions, such as ghost generation or merging; for simple local indices use generateIds or pvPointAndCellIds.

Common mistakes and assumptions:

  • With Tolerance 0, points must coincide exactly; meshes written with rounding need a small positive tolerance.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GlobalPointAndCellIds. Identity: filters/GlobalPointAndCellIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Tolerance Set the tolerance to use to identify coincident points. 0 means the points should be exactly identical. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGlobalPointAndCellIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGlyph#

Places a copy of a glyph shape (arrow, cone, cube, cylinder, line, sphere or 2-D glyph, GlyphType) at points of the input, or at cell centres when the chosen arrays are cell data, oriented by a vector array and scaled by a scalar or vector array; output is polydata. Use it for velocity arrows or sized markers. Use pvGlyphWithCustomSource to glyph with your own geometry.

Common mistakes and assumptions:

  • By ParaView default only up to 5000 points are glyphed (Uniform Spatial Distribution); choose All Points or Every Nth Point when every point must appear.
  • OrientationArray and ScaleArray must have the same association; a point/cell mismatch makes the native filter warn and produce no glyphs.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Glyph. Identity: filters/Glyph. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to this filter. This is the dataset from which the locations are selected to be glyphed. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphMode This property indicates the mode that will be used to generate glyphs from the dataset. {"type":"enum","values":["All Points","Every Nth Point","Uniform Spatial Distribution (Bounds Based)","Uniform Spatial Distribution (Surface Sampling)","Uniform Spatial Distribution (Volume Sampling)"]} native initialisation / omitted "All Points"
GlyphTransform The values in this property allow you to specify the transform (translation, rotation, and scaling) to apply to the glyph source. {"type":"typed proxy","choices":["Transform2"]} native initialisation / omitted {"type":"Transform2"}
GlyphType This property determines which type of glyph will be placed at the points in the input dataset. {"type":"typed proxy","choices":["2D Glyph","Arrow","Box","Cone","Cylinder","Line","Sphere"]} native initialisation / omitted {"type":"Arrow"}
MaximumNumberOfSamplePoints This property specifies the maximum number of sample points to use when sampling the space when Uniform Spatial Distribution is used. {"minimum":1,"type":"integer"} native initialisation / omitted 1
OrientationArray Select the input array to use for orienting the glyphs. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleArray Select the input array to be used for scaling the glyphs. If the scale array is a vector array, you can control how the glyphs are scaled with the Vector Scale Mode property. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleFactor Specify the constant multiplier to use to scale the glyphs. {"type":"number"} native initialisation / omitted 1
Seed This property specifies the seed that will be used for generating a uniform distribution of glyph points when a Uniform Spatial Distribution is used. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Stride This property specifies the stride that will be used when glyphing by Every Nth Point. {"minimum":1,"type":"integer"} native initialisation / omitted 1
VectorScaleMode Select the mode when the scaling array is a vector. Scale by Magnitude scales the glyph by the vector magnitude. Scale by Components scales glyphs by each vector component in the dimension that component represents, e.g., the x-direction is scaled by component 0, the y-direction is scaled by component 1, and so on. {"type":"enum","values":["Scale by Magnitude","Scale by Components"]} native initialisation / omitted "Scale by Magnitude"

Nested GlyphTransform → Transform2#

Syntax: {"type":"Transform2","options":{...}}. Native identity: extended_sources/Transform2. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphTransform.options.Rotate Rotation [rx, ry, rz] of the glyph shape about its local axes, combined in VTK’s Z-X-Y convention (the matrix is RotateZ · RotateX · RotateY); for a rotation about a single axis the order does not matter. The operation then turns the glyph’s x axis onto the orientation vector, so this rotation changes which part of the shape follows the vector. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphTransform.options.Scale Scale factors [sx, sy, sz] applied to the glyph shape along its local axes before any other scaling, for example to make arrows thinner without shortening them. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphTransform.options.Translate Offset [tx, ty, tz] of the glyph shape, applied after its scale and rotation; for example [-0.5, 0, 0] centres a unit-length arrow on the data point. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested GlyphType → 2D Glyph#

Syntax: {"type":"2D Glyph","options":{...}}. Native identity: sources/GlyphSource2D. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Offset [x, y, z] of the symbol from its local origin, i.e. from the data point after glyphing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.DoublePointed When true, the arrow gets a second head at its other end (the -x end), drawn with the same TipLength, so the glyph points both ways along the orientation vector. With PointInwards the shaft is shortened by one TipLength per head and cannot become shorter than zero. Only used when GlyphType is Arrow. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.Filled When true, closed symbols are drawn as filled polygons; when false only their outline is drawn. It only applies to closed symbols. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.GlyphType Symbol to draw. Arrow, ThickArrow, HookedArrow and EdgeArrow point along +x and therefore follow the orientation vector; Dash is a short line along x; Vertex is a single point; Cross, ThickCross, Triangle, Square, Circle and Diamond are position markers. {"type":"enum","values":["Vertex","Dash","Cross","ThickCross","Triangle","Square","Circle","Diamond","Arrow","ThickArrow","HookedArrow","EdgeArrow"]} native initialisation / omitted "Vertex"
GlyphType.options.PointInwards When true, the arrow tip(s) point inwards instead of outwards. Only used when GlyphType is “Arrow”. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.TipLength Length of the arrow tip as a fraction of the unit glyph length. Only used when GlyphType is “Arrow”. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested GlyphType → Arrow#

Syntax: {"type":"Arrow","options":{...}}. Native identity: sources/ArrowSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Invert When true, the tip is at (0, 0, 0) and the shaft base at (1, 0, 0): after glyphing the arrow lies on the same side of the data point but points back toward it, as for flow arriving at the point. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.ShaftRadius Radius of the cylindrical shaft as a fraction of the arrow length. {"maximum":5.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.ShaftResolution Number of facets around the shaft; higher values look rounder but add polygons to every glyph. {"maximum":128,"minimum":3,"type":"integer"} native initialisation / omitted 3
GlyphType.options.TipLength Length of the conical tip as a fraction of the total arrow length (the shaft takes the rest). {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.TipRadius Radius of the widest part of the tip (the cone base) as a fraction of the arrow length. {"maximum":10.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.TipResolution Number of facets around the tip cone: 1 gives a single triangle, 2 two crossed triangles, higher values a rounder cone. {"maximum":128,"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested GlyphType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: sources/CubeSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Centre of the box relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.XLength Edge length along the glyph’s local x axis (the axis aligned with the vector or major eigenvector). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.YLength Edge length along the glyph’s local y axis (the medium eigenvector in Tensor Glyph). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.ZLength Edge length along the glyph’s local z axis (the minor eigenvector in Tensor Glyph). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested GlyphType → Cone#

Syntax: {"type":"Cone","options":{...}}. Native identity: sources/ConeSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Capping When true, the base of the cone is closed with a polygon; when false it is open. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.Center Centre of the cone, which is the midpoint of its axis (not the centre of its base), relative to the glyph’s local origin, i.e. the data point. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Direction Direction from the base centre toward the apex; it need not be normalized. It is relative to the glyph’s local axes, whose x axis Glyph aligns with the vector, so keep [1, 0, 0] for cones that point along the vector. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Height Length of the cone along Direction, from base centre to apex; Center sits at half this length. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Radius Radius of the cone’s base; with Height it sets how slender or blunt each cone looks before the operation scales it. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Resolution Number of sides around the cone: 0 gives a line, 1 a single triangle, 2 two crossed triangles, and larger values a cone with that many sides. {"maximum":512,"minimum":0,"type":"integer"} native initialisation / omitted 0

Nested GlyphType → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: sources/CylinderSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Capping When true, both ends of the cylinder are closed with polygons; when false they are open. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.Center Centre of the cylinder relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Height Length of the cylinder along its local y axis, split equally either side of Center. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Radius Radius of the cylinder’s circular cross-section; with Height it sets how thick each glyph is relative to its length. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Resolution Number of facets around the cylinder; higher values look rounder but add polygons to every glyph. {"maximum":512,"minimum":2,"type":"integer"} native initialisation / omitted 2

Nested GlyphType → Line#

Syntax: {"type":"Line","options":{...}}. Native identity: sources/LineSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Point1 Start of the line in glyph-local coordinates; [0, 0, 0] starts it at the data point. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Point2 End of the line in glyph-local coordinates; keep it on +x so the line follows the vector. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.RefinementRatios Positions along the line, as fractions from 0 (Point1) to 1 (Point2), where points are placed when UseRegularRefinement is false. Include 0 and 1 to keep the end points. {"items":{"maximum":1.0,"minimum":0.0,"type":"number"},"type":"array"} native initialisation / omitted [0.0]
GlyphType.options.Resolution Number of equal segments (Resolution + 1 points) when UseRegularRefinement is true. A straight glyph looks the same at any value; more points only add data. {"minimum":1,"type":"integer"} native initialisation / omitted 1
GlyphType.options.UseRegularRefinement When true, points are spaced evenly using Resolution; when false, they are placed at the fractions listed in RefinementRatios. {"type":"boolean"} native initialisation / omitted false

Nested GlyphType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: sources/SphereSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Centre of the sphere relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.EndPhi Ending latitude measured from the +z pole; 90 gives the upper hemisphere, 180 the full sphere. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.EndTheta Ending longitude about the local z axis; less than 360 leaves the sphere open. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.PhiResolution Number of divisions in latitude (phi, measured from the +z pole) between StartPhi and EndPhi. {"minimum":3,"type":"integer"} native initialisation / omitted 3
GlyphType.options.Radius Radius of the sphere; the static 0.5 gives a glyph of unit diameter before the operation’s scaling. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.StartPhi Starting latitude measured from the +z pole (0) toward the −z pole (180); values above 0 cut off a cap at the top. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.StartTheta Starting longitude, about the local z axis; with EndTheta it lets you draw only a wedge of the sphere. A full sphere uses 0 to 360. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.ThetaResolution Number of divisions around the sphere in longitude (theta, about the local z axis) between StartTheta and EndTheta; higher values look rounder but add polygons to every glyph. {"minimum":3,"type":"integer"} native initialisation / omitted 3

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGlyph",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGlyphWithCustomSource#

Like pvGlyph, but the glyph geometry is any polydata connected to the GlyphSource input (e.g. a CAD part or a custom marker), placed at points or cell centres, oriented by a vector array and scaled by a scalar or vector array; output is polydata. Use it when the built-in shapes are not enough.

Common mistakes and assumptions:

  • By ParaView default only up to 5000 points are glyphed (Uniform Spatial Distribution); choose All Points or Every Nth Point when every point must appear.
  • OrientationArray and ScaleArray must have the same association; a point/cell mismatch makes the native filter warn and produce no glyphs.
  • The glyph geometry is used in its own coordinates: an arrow-like source should point along +x and be centred where it should attach.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GlyphWithCustomSource. Identity: filters/GlyphWithCustomSource. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
GlyphSource Required data input for the native GlyphSource port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to this filter. This is the dataset from which the locations are selected to be glyphed. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphMode This property indicates the mode that will be used to generate glyphs from the dataset. {"type":"enum","values":["All Points","Every Nth Point","Uniform Spatial Distribution"]} native initialisation / omitted "All Points"
GlyphTransform The values in this property allow you to specify the transform (translation, rotation, and scaling) to apply to the glyph source. {"type":"typed proxy","choices":["Transform2"]} native initialisation / omitted {"type":"Transform2"}
MaximumNumberOfSamplePoints This property specifies the maximum number of sample points to use when sampling the space when Uniform Spatial Distribution is used. {"minimum":1,"type":"integer"} native initialisation / omitted 1
OrientationArray Select the input array to use for orienting the glyphs. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleArray Select the input array to be used for scaling the glyphs. If the scale array is a vector array, you can control how the glyphs are scaled with the Vector Scale Mode property. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleFactor Specify the constant multiplier to use to scale the glyphs. {"type":"number"} native initialisation / omitted 1
Seed This property specifies the seed that will be used for generating a uniform distribution of glyph points when a Uniform Spatial Distribution is used. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Stride This property specifies the stride that will be used when glyphing by Every Nth Point. {"minimum":1,"type":"integer"} native initialisation / omitted 1
VectorScaleMode Select the mode when the scaling array is a vector. Scale by Magnitude scales the glyph by the vector magnitude. Scale by Components scales glyphs by each vector component in the dimension that component represents, e.g., the x-direction is scaled by component 0, the y-direction is scaled by component 1, and so on. {"type":"enum","values":["Scale by Magnitude","Scale by Components"]} native initialisation / omitted "Scale by Magnitude"

Nested GlyphTransform → Transform2#

Syntax: {"type":"Transform2","options":{...}}. Native identity: extended_sources/Transform2. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphTransform.options.Rotate Rotation [rx, ry, rz] of the glyph shape about its local axes, combined in VTK’s Z-X-Y convention (the matrix is RotateZ · RotateX · RotateY); for a rotation about a single axis the order does not matter. The operation then turns the glyph’s x axis onto the orientation vector, so this rotation changes which part of the shape follows the vector. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphTransform.options.Scale Scale factors [sx, sy, sz] applied to the glyph shape along its local axes before any other scaling, for example to make arrows thinner without shortening them. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphTransform.options.Translate Offset [tx, ty, tz] of the glyph shape, applied after its scale and rotation; for example [-0.5, 0, 0] centres a unit-length arrow on the data point. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGlyphWithCustomSource",
  "inputs": {
    "GlyphSource": "UPSTREAM_GlyphSource",
    "Input": "UPSTREAM_Input"
  }
}

pvGradient#

Full native Gradient: estimates the gradient of a point or cell array (3 components for a scalar, 9 for a vector), optionally with divergence, vorticity and Q-criterion, and adds them as arrays on the same mesh. Extra settings cover result names, boundary treatment and dimensionality for image data, which neighbouring cells contribute, the value used where no gradient can be computed, a faster approximation, and hyper-tree-grid modes. Use gradient for the common case.

Common mistakes and assumptions:

  • Divergence, vorticity and Q-criterion need a 3-component input array.
  • ParaView fills points where the gradient cannot be computed with NaN by default (ReplacementValueOption); such NaNs propagate into later integrals.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Gradient. Identity: filters/Gradient. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the input to the Gradient filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundaryMethod Specify how to compute the gradient on the boundaries. 'Smoothed' uses central differencing by duplicating the boundary values to compute the gradient on the boundary elements (corresponds to the old 'Gradient' filter). 'Non-Smoothed' uses forward/backward differencing with the values of a boundary element and its neighbor to compute the gradient (corresponds to the old 'Gradient Of Unstructured DataSet' filter). {"type":"enum","values":["Smoothed","Non-Smoothed"]} native initialisation / omitted "Smoothed"
ComputeDivergence If on, the divergence of a 3-component array is computed. {"type":"boolean"} native initialisation / omitted false
ComputeGradient If on, the gradient of the input array is computed. {"type":"boolean"} native initialisation / omitted false
ComputeQCriterion If on, the Q-criterion of a 3-component array is computed. {"type":"boolean"} native initialisation / omitted false
ComputeVorticity If on, the vorticity/curl of a 3-component array is computed. {"type":"boolean"} native initialisation / omitted false
ContributingCellOption Specify which dimensions of cells should be used when computing gradient quantities. Default is to use the dataset maximum cell dimension. {"type":"enum","values":["All","Patch","Dataset Max"]} native initialisation / omitted "All"
Dimensionality Specify whether to compute the gradient in two or three dimensions. In two dimensions, the X and Y dimensions are used. {"type":"enum","values":["Two","Three"]} native initialisation / omitted "Two"
DivergenceArrayName Provide a name for the output array containing the divergence vector. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ExtensiveComputation Use the extensive ratio during the Hyper Tree Grid gradient computation. This property only work in UNLIMITED mode. {"type":"boolean"} native initialisation / omitted false
FasterApproximation If on, the Gradient filter will provide a less accurate (but close) algorithm that performs fewer derivative calculations (and is therefore faster). The error contains some smoothing of the output data and some possible errors on the boundary. Has no effect when performing the gradient of cell data or when the input grid is not a vtkUnstructuredGrid. {"type":"boolean"} native initialisation / omitted false
HTGMode Specify how to compute the gradient on a Hypertree Grid. 'Unlimited' handles the resolution change by virtually subdividing coarser cells and eventually applyging a ratio. 'Unstructured' operate like the AMR like if it was an unstructured mesh, which may give a higher weight to coarser cells. {"type":"enum","values":["Unlimited","Unstructured"]} native initialisation / omitted "Unlimited"
QCriterionArrayName Provide a name for the output array containing the Q criterion. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ReplacementValueOption Specify what value to use when the gradient quantities at a point cannot be computed with the selected ContributingCellOption. {"type":"enum","values":["Zero","NaN","Data Type Min","Data Type Max"]} native initialisation / omitted "Zero"
ResultArrayName Provide a name for the output array containing the gradient vectors. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ScalarArray Specify the name of the scalar array from which to compute the gradient. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
VorticityArrayName Provide a name for the output array containing the vorticity vector. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGradient",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGradientMagnitude#

Computes the magnitude of the spatial gradient of an image's point scalars with central differences that account for the pixel spacing, giving image data of the same size (edge values use one-sided neighbours). It is the classic edge-strength image, useful to locate interfaces or fronts. Dimensionality decides whether the z derivative is included. For gradients of general meshes, or vector results, use gradient.

Common mistakes and assumptions:

  • The output has the input's scalar type, so an integer image gives a truncated integer magnitude; convert to float first when precision matters.
  • Multi-component scalars are differentiated per component, not combined.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GradientMagnitude. Identity: filters/GradientMagnitude. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Gradient Magnitude filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Dimensionality This property indicates whether to compute the gradient magnitude in two or three dimensions. If computing the gradient magnitude in 2D, the gradients in X and Y are used for computing the gradient magnitude. {"type":"enum","values":["Two","Three"]} native initialisation / omitted "Two"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGradientMagnitude",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvGroupDatasets#

Combines several inputs into one composite dataset, each input becoming one block: a multiblock dataset by ParaView default, or a partitioned dataset (all inputs as partitions of one block) or partitioned dataset collection. Use it to process, colour or export separate nodes together; use append or merge when you need one merged mesh instead. The curated group is the simpler alternative.

Common mistakes and assumptions:

  • Block names are ignored for the vtkPartitionedDataSet output type.
  • Later operations that require a single dataset need merge or extractBlock after grouping.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GroupDatasets. Identity: filters/GroupDataSets. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: This property indicates the inputs to the Group Datasets filter. Accepted data: any data object (vtkDataObject); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BlockNames Specify names to use for each input. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
OutputType Specify the output type in which to group the inputs. {"type":"enum","values":["vtkMultiBlockDataSet","vtkPartitionedDataSet","vtkPartitionedDataSetCollection"]} native initialisation / omitted "vtkMultiBlockDataSet"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGroupDatasets",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvGroupTimeSteps#

Loads every time step of the input and returns them together as one dataset without time: a multiblock if the input is multiblock, otherwise a partitioned dataset collection, with one block per step named timestep0, timestep1, … (zero-based step index, not the time value). Use it to overlay or export all steps at once, e.g. to compare particle positions.

Common mistakes and assumptions:

  • Every step is held in memory at once; avoid it on long series of large meshes.
  • Block names carry the step index; keep the input's time values separately if you need them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: GroupTimeSteps. Identity: filters/GroupTimeSteps. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvGroupTimeSteps",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvH5PartReader#

Reads H5Part particle files (.h5part, an HDF5 layout used by accelerator and plasma codes) into polydata points with the selected particle arrays; every step stored in the file becomes a time step (time values from the file, or the step index when they are missing). Coordinates come from three scalar arrays chosen by Xarray, Yarray and Zarray (by default the first of x, coords_0, coords0 and so on that exists).

Common mistakes and assumptions:

  • If the coordinate arrays are not called x/y/z or coords_0/1/2, set Xarray, Yarray and Zarray, or every particle is placed incorrectly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: H5PartReader. Identity: sources/H5PartReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Path of the H5Part file; all time steps are stored inside it, so one file gives the whole time series. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder; the value is passed when the node is created and must be a constant. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
GenerateVertexCells When true, one vertex cell is created per particle; false produces points and point arrays only. Many ParaView filters and representations operate on cells, so keep it on unless only coordinates are needed and memory is tight. {"type":"boolean"} native initialisation / omitted false
MaskOutOfTimeRangeOutput When true, a request for a time before the first or after the last stored step returns an empty dataset; when false the reader clamps to the first or last step. Turn it on when combining with data that span a longer time so particles do not appear frozen. {"type":"boolean"} native initialisation / omitted false
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Xarray This property lists which point array to use for coordinates. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Yarray This property lists which point array to use for coordinates. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Zarray This property lists which point array to use for coordinates. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvH5PartReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvHDF5RageReader#

Reads RAGE simulation output stored in HDF5 through an ASCII descriptor that lists the data files and the type and order of the variables (ParaView registers the .h5rage extension; the native text calls it a .pio file). The output is uniform image data with the selected variables as point arrays, one time step per data file.

Common mistakes and assumptions:

  • Keep the descriptor and the HDF5 files it lists together.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: HDF5RageReader. Identity: sources/H5RageReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName ASCII .pio file describes locations of data files, type and order of data written to the files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays Variables written to the data files are described in the .pio file and are presented for selection. Only selected variables are loaded for a time step. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHDF5RageReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvHDRReader#

Reads a Radiance HDR image (.hdr, run-length-encoded RGBE or XYZE) into 2-D uniform image data with 32-bit floating-point colour channels, keeping the full dynamic range for analysis or image-based lighting. Use pvPNGSeriesReader or pvTIFFSeriesReader for ordinary 8- or 16-bit images.

Common mistakes and assumptions:

  • Values are linear radiance, not display-ready colours; apply your own tone mapping or colour map before comparing with ordinary images.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HDRReader. Identity: sources/HDRReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Path of the Radiance HDR file to read. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder; absolute paths avoid ambiguity. The value is a constructor option, so it must be a constant. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHDRReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvHierarchicalDataIDSelectionSource#

Creates an index selection inside an AMR (overlapping AMR / hierarchical box) dataset: each entry names an AMR level, a dataset (box) within that level and a zero-based point or cell index inside that box. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvCompositeDataIDSelectionSource for multiblock data and pvIDSelectionSource for a single non-composite dataset.

Common mistakes and assumptions:

  • IDs must be complete triples; Schemaxis rejects a list whose length is not a multiple of 3.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HierarchicalDataIDSelectionSource. Identity: sources/HierarchicalDataIDSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
IDs The list of IDs that will be added to the selection produced by the selection source. This takes 3-tuple of values as (level, index, id). Complete tuples of 3 values. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHierarchicalDataIDSelectionSource"
}

pvHierarchicalFractal#

Test source that builds a refined hierarchy of uniform (or rectilinear) grid blocks around a Mandelbrot-set fractal, with a cell array scaled to look like a material volume fraction (0.5 at FractalValue). It produces a composite, AMR-like dataset and exists to exercise AMR, ghost-level and material-interface filters, not to represent physical data. For an AMR test pulse use pvAMRGaussianPulseSource; for a single-block fractal use pvMandelbrot.

Common mistakes and assumptions:

  • The output type differs with RectilinearGrids (hierarchical box versus multiblock, per the VTK class notes); check it before connecting type-specific filters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HierarchicalFractal. Identity: sources/HierarchicalFractal. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Asymetric If this property is set to 0, all the blocks will be the same size. If it is set to 1, an asymmetric dataset will be created: some blocks will have an X dimension that is larger by 2 units. {"type":"boolean"} native initialisation / omitted false
Dimensions This property specifies the X, Y, Z cell dimensions of a block. {"maximum":64,"minimum":2,"type":"integer"} native initialisation / omitted 2
FractalValue The value of this property will be mapped to 0.5 for use as a volume fraction. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GhostLevels This property specifies whether ghost levels should be generated at processor boundaries. {"type":"boolean"} native initialisation / omitted false
MaximumLevel This property specifies how many levels of refinement should be included in this hierarchical dataset. {"maximum":10,"minimum":1,"type":"integer"} native initialisation / omitted 1
RectilinearGrids If this property is set to 1, the hierarchical dataset will contain rectilinear grids; otherwise it will contain uniform grids. {"type":"boolean"} native initialisation / omitted false
TimeStep This property specifies the timestep to use for this dataset. {"type":"integer"} native initialisation / omitted 1
TwoDimensional If this property is set to 1, the generated dataset will be 2D; otherwise it will be 3D. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHierarchicalFractal"
}

pvHistogram#

Bins one component (or the magnitude) of one array into equal-width bins and outputs a table with bin_extents (bin centre positions) and bin_values (counts), plus per-bin averages of the other arrays when CalculateAverages is on. Use it to study a value distribution, e.g. of pressure or velocity magnitude over a mesh. Counts are per point or per cell, not weighted by cell size. Use pvHistogram2D for the joint distribution of two variables.

Common mistakes and assumptions:

  • On a non-uniform mesh, unweighted counts do not represent volume or area fractions.
  • With custom bin ranges, values outside the range are clamped into the first or last bin, not discarded.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Histogram. Identity: filters/ExtractHistogram. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Histogram filter. Accepted data: any data object (vtkDataObject). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BinCount The value of this property specifies the number of bins for the histogram. {"maximum":256,"minimum":1,"type":"integer"} native initialisation / omitted 1
CalculateAverages This option controls whether the algorithm calculates averages of variables other than the primary variable that fall into each bin. {"type":"boolean"} native initialisation / omitted false
CenterBinsAroundMinAndMax When set to true, first and last bin will be centered around the minimum and the maximum values of the data. By default, set to false. {"type":"boolean"} native initialisation / omitted false
Component The value of this property specifies the array component from which the histogram should be computed. {"type":"integer"} native initialisation / omitted 1
CustomBinRanges Set custom bin ranges to use. These are used only when UseCustomBinRanges is set to true. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
Normalize Controls whether the values in the output are normalized, i.e., the count in each bin is divided by the sum of counts in each bin. {"type":"boolean"} native initialisation / omitted false
SelectInputArray This property indicates the name of the array from which to compute the histogram. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
UseCustomBinRanges When set to true, CustomBinRanges will be used instead of using the full range for the selected array. By default, set to false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHistogram",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHistogram2D#

Builds a joint (2-D) histogram of two array components and outputs it as a 2-D image (vtkImageData) whose point scalars are the counts: X-variable bins along the image x axis, Y bins along y. By ParaView default the Y variable is the gradient magnitude of the X array, the value-versus-gradient plot used to design volume-rendering transfer functions; turn UseGradientasYAxisArray off to histogram two arbitrary arrays, e.g. temperature against pressure. Both arrays must have the same association and number of tuples. Use pvHistogram for one variable.

Common mistakes and assumptions:

  • Origin and spacing only place the image; binning always spans the arrays' finite ranges or the custom ranges. With the defaults (origin [0, 0], spacing [1, 1]) image coordinates are bin indices; enable HistogramBoundsfromInput to read the axes in data units.
  • While UseGradientasYAxisArray is true (the native default), InputArrayforYAxis and the Y custom range are ignored.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Histogram2D. Identity: filters/ExtractHistogram2D. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Histogram filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComponentforXAxisarray The value of this property specifies the array component from which the histogram should be computed. {"type":"integer"} native initialisation / omitted 1
ComponentforYAxisarray The value of this property specifies the array component from which the histogram should be computed. {"type":"integer"} native initialisation / omitted 1
CustomBinRangesforXAxis Set custom bin ranges to use. These are used only when UseCustomBinRanges is set to true. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
CustomBinRangesforYAxis Set custom bin ranges to use. These are used only when UseCustomBinRanges is set to true. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
HistogramBoundsfromInput When set to true, the input scalar ranges will be used to compute the histogram origin and spacing. By default, set to false. {"type":"boolean"} native initialisation / omitted false
HistogramOrigin The origin of the output histogram image. These are used only when UseInputRangesForOutputBounds is set to false. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
HistogramSpacing The pixel spacing of the output histogram image. These are used only when UseInputRangesForOutputBounds is set to false. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
InputArrayforXAxis This property indicates the name of the array from which to compute the histogram. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
InputArrayforYAxis This property indicates the name of the array from which to compute the histogram. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
NumberofBins Number of bins along each axis as [X bins, Y bins]; these are also the output image dimensions in pixels. Each variable's range is divided among its bins, so more bins resolve finer structure but leave fewer samples per bin and noisier counts. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
UseCustomBinRangesforXAxis When set to true, custom bin ranges will be used instead of using the full range for the selected array for X axis. By default, set to false. {"type":"boolean"} native initialisation / omitted false
UseCustomBinRangesforYAxis When set to true, custom bin ranges will be used instead of using the full range for the selected array for X axis. By default, set to false. {"type":"boolean"} native initialisation / omitted false
UseGradientasYAxisArray If this property is on, the gradient of the input scalar array will be used for the Y axis of the 2D histogram. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHistogram2D",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGrid#

Builds a hyper tree grid (vtkHyperTreeGrid), a tree-based AMR structure: a rectilinear grid of root cells, each refined recursively by a binary (BranchFactor 2) or ternary (3) subdivision described by the Descriptor string. In the descriptor, levels are separated by "|", "R" marks a refined cell and "." a leaf, e.g. "RR | .R. ... | ...". Use it to construct exact test cases for hyper-tree-grid filters; for random trees use pvHyperTreeGridRandom.

Common mistakes and assumptions:

  • The descriptor must be consistent with Dimensions, BranchFactor and MaxDepth (one character per cell on each level); an inconsistent string produces an error or an empty grid.
  • Many standard filters do not accept hyper tree grids directly; convert to an unstructured grid first when needed.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: HyperTreeGrid. Identity: sources/HyperTreeGridSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BranchFactor This property specifies the subdivision scheme (binary or ternary) of the hyper tree grid. {"maximum":3,"minimum":2,"type":"integer"} native initialisation / omitted 2
Descriptor This property specifies the string used to describe the hyper tree grid. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Dimensions The three values in this property specify the number of points in each dimension of the hyper tree grid. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GridScale The three values in this property specify the scale of the root cells in each dimension of the hyper tree grid. {"items":{"minimum":0.0,"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [0.0,0.0,0.0]
MaxDepth The value of this property specifies the maximum number of levels in the hyper tree grid. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGrid"
}

pvHyperTreeGridAxisReflection#

Mirrors a hyper tree grid (vtkHyperTreeGrid, an adaptively refined tree-based grid) across a plane perpendicular to x, y or z: PlaneNormal picks the axis and PlanePosition the plane's coordinate on it. The output holds only the mirrored grid, unlike pvReflect, which can keep the original too, and cell arrays are copied unchanged. For ordinary datasets use reflect or pvReflect.

Common mistakes and assumptions:

  • Omitted, PlaneNormal reads back "X Axis" when the node is created, whatever the XML says (a bounded native probe), so by the source the grid is mirrored about x = PlanePosition (x = 0 unless PlanePosition is set), not about its minimum-x face. Set PlaneNormal to mirror about y or z.
  • Vector cell arrays are not flipped; their mirrored component keeps its original sign.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridAxisReflection. Identity: filters/HyperTreeGridAxisReflection. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
PlaneNormal Axis perpendicular to the mirror plane: X Axis mirrors x coordinates about x = PlanePosition, and Y Axis and Z Axis do the same for y and z. {"type":"enum","values":["X Axis","Y Axis","Z Axis"]} native initialisation / omitted "X Axis"
PlanePosition Position of the reflection plane along the normal axis. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridAxisReflection",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridCellCenters#

Produces a point cloud (polydata) with one point at the centre of each leaf cell of a hyper tree grid; the cell arrays become point arrays on those points. CreateVertexCells (ParaView default true) adds a vertex per point so the points render and count as cells. Use it for glyphs or for sampling HTG data at cell centres; for ordinary meshes use pvCellCenters.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridCellCenters. Identity: filters/HyperTreeGridCellCenters. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CreateVertexCells If enabled, vertex cells will be added to the output dataset. This is useful for visualizing the output points, which are not rendered otherwise. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridCellCenters",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridDepthLimiter#

Truncates a hyper tree grid at a maximum refinement depth: cells at depth SetDepth become leaves and finer levels are dropped, giving a coarser view of an adaptively refined grid. Depth counts from 0 at the root cells; if it is at least the grid's deepest level, the output equals the input. With a material mask present, ParaView notes that the output extent can be larger than the input's.

Common mistakes and assumptions:

  • ParaView's static SetDepth is 0, which keeps only the root (coarsest) cells; set the level you want.
  • Truncated cells show the values already stored on coarse cells; run pvHyperTreeGridEvaluateCoarse first if they should summarise their children.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridDepthLimiter. Identity: filters/HyperTreeGridDepthLimiter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SetDepth Maximum depth to which the output grid should be limited. {"minimum":0,"type":"integer"} native initialisation / omitted 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridDepthLimiter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridEvaluateCoarse#

Recomputes the values stored on refined (coarse) cells of a hyper tree grid from their children, for every cell array, with the chosen Operator: Min, Max, Sum, Average (masked children count as Default), Unmasked Average, Elder Child (the first child's value) or Splatting Average; the Don't change options leave coarse values as they are. Leaf values are unchanged. Use it before coarse-level views such as pvHyperTreeGridDepthLimiter so coarse cells summarise their children.

Common mistakes and assumptions:

  • ParaView's initial Operator is Don't change fast, which does nothing; choose an operator explicitly.
  • Sum and Average are not size-weighted in any physical unit; they combine child values directly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridEvaluateCoarse. Identity: filters/HyperTreeGridEvaluateCoarse. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Default The default value assigned. {"type":"number"} native initialisation / omitted 1
Operator Different Calculation Methods {"type":"enum","values":["Unmasked Average","Min","Max","Sum","Average","Don't change fast","Don't change","Elder Child","Splatting Average"]} native initialisation / omitted "Unmasked Average"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridEvaluateCoarse",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridFeatureEdgesFilter#

Generates polygonal lines along the feature edges of a hyper tree grid: the grid itself in 1-D, border edges in 2-D, and edges where faces meet at 90 degrees in 3-D, computed while traversing the trees so T-junctions between refinement levels are handled. Use it to outline HTG geometry in images; for ordinary meshes use featureEdges or pvFeatureEdges.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridFeatureEdgesFilter. Identity: filters/HyperTreeGridFeatureEdges. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MergePoints Select whether to merge duplicated points. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridFeatureEdgesFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridGeometryFilter#

Extracts the external surface of a hyper tree grid as polydata: segments for a 1-D grid and faces for 2-D and 3-D grids, cut along material interfaces when the grid carries them, with cell data on the output faces. Use it to render or export an HTG surface; for volume operations convert with pvHyperTreeGridToUnstructuredGrid or pvHyperTreeGridToDualGrid.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridGeometryFilter. Identity: filters/HyperTreeGridGeometry. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridGeometryFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridGhostCellsGenerator#

Generates ghost hyper trees at the interfaces between MPI processes for a distributed hyper tree grid, containing only the interface nodes and leaves. It is needed only in parallel runs before filters that use neighbour (Von Neumann or Moore) super-cursors; a serial run has no process interfaces. For ordinary datasets use pvGhostCellsGenerator.

Common mistakes and assumptions:

  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridGhostCellsGenerator. Identity: filters/HyperTreeGridGhostCellsGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specified the input to the ghost cell generator. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridGhostCellsGenerator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridRandom#

Builds a hyper tree grid (vtkHyperTreeGrid) with pseudo-random binary refinement: each node is split with probability SplitFraction down to MaxDepth, a target MaskedFraction of cells is masked, and the root grid spans OutputBounds. A "Depth" cell array records each cell's level. The same Seed reproduces the same tree. Use it to stress-test hyper-tree-grid filters; use pvHyperTreeGrid for an exactly specified tree.

Common mistakes and assumptions:

  • Cell counts grow quickly with MaxDepth and SplitFraction; start with small values.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: HyperTreeGridRandom. Identity: sources/RandomHyperTreeGridSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Dimensions Grid size as [nx, ny, nz]. VTK's vtkRandomHyperTreeGridSource interprets these as numbers of points per axis, so there are (n - 1) root trees along each axis: the default [6, 6, 3] gives 5 × 5 × 2 roots. The native documentation's "number of root cells" wording is off by one. {"items":{"minimum":1,"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
MaskedFraction The total fraction of cell volume to be masked during construction. This is a target value and the actual fraction of masked volume can vary depending on number of tree and children. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
MaxDepth The value of this property specifies the maximum number of levels in the hyper tree grid. {"minimum":1,"type":"integer"} native initialisation / omitted 1
OutputBounds The bounds of the resulting dataset. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
Seed Seed of the pseudo-random generator that decides which nodes are split and masked (tree i uses Seed + i). Keeping it fixed reproduces the same grid; changing it gives a different random tree with similar statistics. {"type":"integer"} native initialisation / omitted 1
SplitFraction The chance that a given node will be split during construction. Higher values mean more splits. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridRandom"
}

pvHyperTreeGridReader#

Reads a VTK XML hypertree grid file (.htg): an adaptive tree-based mesh (vtkHyperTreeGrid) in which each coarse cell is refined recursively, typical of AMR codes. MaximumNumberOfLevels limits the refinement depth loaded and BoundingBoxByCoordinates loads only the trees touching a box, both cutting memory and read time. Several files form a time series. Use pvXMLPartitionedHyperTreeGridReader for partitioned .phtg data.

Common mistakes and assumptions:

  • Many general filters do not accept hypertree grids; convert with pvHyperTreeGridToUnstructuredGrid when needed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: HyperTreeGridReader. Identity: sources/HyperTreeGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundingBoxByCoordinates This property sets the bounding box to select HyperTrees. HyperTrees completely included or intersecting with the bounding box will be selected and fully loaded (no partial tree). The 6 fields are coordinates of the bounding box, in the following order: Xmin, Xmax, Ymin, Ymax, Zmin, Zmax. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaximumNumberOfLevels This property sets the maximum level to load. Setting it to 1 shows the coarse grid of trees, and setting it at or past maximum level of the data will load the data at finest resolution. When set to a value between (excluded) 1 and the maximum level of the trees, data will be loaded at the required lower resolution, considerably faster. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvHyperTreeGridToDualGrid#

Converts a hyper tree grid to its dual unstructured grid: one point at the centre of each leaf cell, cells connecting neighbouring centres, and the HTG cell arrays turned into point arrays. The result works with the standard filters (contour, slice, gradient) and gives smooth point-interpolated fields, but uses much more memory than the HTG. Use pvHyperTreeGridToUnstructuredGrid to keep the original leaf cells and cell values.

Common mistakes and assumptions:

  • The dual mesh covers the region between leaf centres, so it stops half a cell short of the HTG boundary.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridToDualGrid. Identity: filters/HyperTreeGridToDualGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the converter. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridToDualGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridToUnstructuredGrid#

Converts every leaf of a hyper tree grid into an explicit unstructured-grid cell (segments in 1-D, rectangles in 2-D, right hexahedra in 3-D) with the cell arrays kept. The result works with all standard filters but uses much more memory, and cells at different refinement levels meet at T-junctions (hanging nodes), so faces are not conformally connected. Use pvHyperTreeGridToDualGrid for a point-based dual mesh.

Common mistakes and assumptions:

  • Because of T-junctions, connectivity and surface filters can see internal boundaries where refinement levels change.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridToUnstructuredGrid. Identity: filters/HyperTreeGridToUnstructuredGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the converter. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridToUnstructuredGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvHyperTreeGridVisibleLeavesSize#

Adds two double cell arrays to a hyper tree grid: ValidCell, 1.0 for leaves that are neither masked nor ghost and 0.0 otherwise, and CellSize, the cell's volume in 3-D, area in 2-D or length in 1-D, derived from its refinement level. Multiplying a field by both and summing gives a size-weighted total over visible leaves, e.g. the grid's total volume. Run it again if cells are refined afterwards.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: HyperTreeGridVisibleLeavesSize. Identity: filters/HyperTreeGridVisibleLeavesSize. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellSizeArrayName Name of the cell size array in the output. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ValidCellArrayName Name of the cell validity array in the output. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvHyperTreeGridVisibleLeavesSize",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvIDSelectionSource#

Creates an index selection: points or cells (per FieldType) chosen by their zero-based position in a single, non-composite dataset, each given with the MPI process that owns it. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Indices change whenever the mesh or its decomposition changes; use pvGlobalIDSelectionSource for stable IDs and pvCompositeDataIDSelectionSource for multiblock data.

Common mistakes and assumptions:

  • ParaView documents that this source cannot select within composite datasets; merge or extract a block first.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: IDSelectionSource. Identity: sources/IDSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
IDs The list of IDs that will be added to the selection produced by the selection source. This takes pairs of values as (process number, id). Complete tuples of 2 values. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIDSelectionSource"
}

pvIGESReader#

Reads a IGES CAD file through OpenCASCADE and tessellates its B-rep faces into triangles, giving a multiblock dataset with one polydata block per shape (named from the file, or Unnamed) and a per-cell Colors array from the CAD colours. LinearDeflection and AngularDeflection set how closely the triangles follow curved surfaces; ReadWire adds edges as polylines. Use it to bring CAD geometry in for rendering, clipping or probing; use pvSTEPReader for .step/.stp, and readSTL or pvSTLReader for already-tessellated STL.

Common mistakes and assumptions:

  • VTK applies no unit conversion; compare the output bounds with the simulation's length unit before combining them.
  • LinearDeflection is an absolute distance in model units unless RelativeDeflection is on; the default 0.1 can be very coarse for small parts, so scale it to the model size.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: IGESReader. Identity: sources/IGESReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AngularDeflection Limits the angle between two subsequent segments. {"type":"number"} native initialisation / omitted 1
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
LinearDeflection Limits the distance between a curve and the resulting tesselation. {"type":"number"} native initialisation / omitted 1
ReadWire Determines if 1D cells will be read. If enabled, surface boundaries are read. {"type":"boolean"} native initialisation / omitted false
RelativeDeflection Determines if the deflection values are relative to object size. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIGESReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvIOSSCellGridReader#

Reads IOSS databases (Exodus, including the discontinuous-Galerkin .exdg variant) into a partitioned dataset collection whose partitions are cell grids (vtkCellGrid), ParaView's representation for higher-order and DG cells with attributes defined per cell type. Use it when cell-grid filters (pvCellGridElevation, pvCellGridProbe) or high-order fields are needed; use pvIOSSReader for ordinary unstructured grids accepted by most filters.

Common mistakes and assumptions:

  • Most classic dataset filters do not accept vtkCellGrid; convert or use pvIOSSReader when a later step needs an unstructured grid.
  • RemoveUnusedPoints and MergeExodusEntityBlocks of the base IOSS reader are ignored.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: IOSSCellGridReader. Identity: sources/IOSSCellGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ApplyDisplacements Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard EXODUS displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter. {"type":"boolean"} native initialisation / omitted false
AssemblySelectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
DisplacementMagnitude When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling. {"type":"number"} native initialisation / omitted 1
EdgeSetFields Select the edge sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSets Select the edge sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlockFields Select the element blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlocks Select the element blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetFields Select the element sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSets Select the element sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetFields Select the face sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSets Select the face sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldSuffixSeparator Set the character used to separate suffix from the field. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileName This property specifies the file name for the IOSS reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FileRange To limit reading a subset of files in spatial file-series, specify a valid range. You may also use FileStride to step over files in this range. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
FileStride Specify the stride to use when reading a subset of files as dictated by the FileRange. {"maximum":100,"minimum":1,"type":"integer"} native initialisation / omitted 1
GenerateFileId When checked, the reader will add a cell array called 'file_id' indicate which partitioned file the cell came from. {"type":"boolean"} native initialisation / omitted false
GroupNumericVectorFieldComponents Set whether the reader should treat numeric suffices for a vector field as vector components of a vtkDataArray. By default, fields with numeric suffices are not grouped into a single vtkDataArray. {"type":"boolean"} native initialisation / omitted false
NodeBlockFields Names of the nodal (point) fields to read, i.e. fields of the node block shared by every block and set, such as displacement, velocity or temperature. vtkIOSSReader enables all fields by default; listing names keeps only these. (The ParaView 5.13.3 XML text says "edge blocks" here, which is a copy error.) {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetFields Select the node sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSets Select the node sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ReadAllFilesToDetermineStructure When set to true (default), the reader will read all files to determine structure of the dataset because some files might have certain blocks that other files don't have. Set to false if you are sure that all files have the same structure, i.e. same blocks and sets. When set to false, the reader will only read the first file to determine the structure. which is faster than reading all files. {"type":"boolean"} native initialisation / omitted false
ReadGlobalFields When checked, the reader will read global fields, if available. {"type":"boolean"} native initialisation / omitted false
ReadIds When checked, the reader will read 'ids' and 'element_side' fields, if available. {"type":"boolean"} native initialisation / omitted false
ReadQAAndInformationRecords When checked, the reader will read quality assurance and information records, if available. {"type":"boolean"} native initialisation / omitted false
ScanForRelatedFiles This reader can lookup additional related files using pattern matching based on the files provided. This is useful to lookup restarted results, for example. To avoid this behavior, uncheck this property. {"type":"boolean"} native initialisation / omitted false
SideSetFields Select the side sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSets Select the side sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StructuredBlockFields Select the structured blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StructuredBlocks Select the structured blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIOSSCellGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvIOSSReader#

Reads Exodus II and CGNS databases through Sandia's IOSS library into a partitioned dataset collection: one partitioned dataset per selected block or set, organized in an assembly by entity type. Spatially partitioned files (name.e.N.r) and restart series (name.e-s.001…) are found automatically. By default all blocks and all fields are read and sets are not. Choose it for finite-element results from Sierra, MOOSE or other Exodus writers; pvExodusIIReader is the older Exodus reader and pvCGNSSeriesReader handles CGNS files IOSS cannot open.

Common mistakes and assumptions:

  • Sets (node, side, element sets) are off by default; list them in NodeSets or SideSets to see boundary groups.
  • Nodal displacements are applied to coordinates by default (ApplyDisplacements); turn it off to see the undeformed mesh.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: IOSSReader. Identity: sources/IOSSReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ApplyDisplacements Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard EXODUS displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter. {"type":"boolean"} native initialisation / omitted false
AssemblySelectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Caching This reader can cache the data that it read across different time steps. The default is off. {"type":"boolean"} native initialisation / omitted false
DisplacementMagnitude When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling. {"type":"number"} native initialisation / omitted 1
EdgeBlockFields Select the edge blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeBlocks Select the edge blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetFields Select the edge sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSets Select the edge sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlockFields Select the element blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlocks Select the element blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetFields Select the element sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSets Select the element sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlockFields Select the face blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlocks Select the face blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetFields Select the face sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSets Select the face sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldSuffixSeparator Set the character used to separate suffix from the field. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileName This property specifies the file name for the IOSS reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FileRange To limit reading a subset of files in spatial file-series, specify a valid range. You may also use FileStride to step over files in this range. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
FileStride Specify the stride to use when reading a subset of files as dictated by the FileRange. {"maximum":100,"minimum":1,"type":"integer"} native initialisation / omitted 1
GenerateFileId When checked, the reader will add a cell array called 'file_id' indicate which partitioned file the cell came from. {"type":"boolean"} native initialisation / omitted false
GroupNumericVectorFieldComponents Set whether the reader should treat numeric suffices for a vector field as vector components of a vtkDataArray. By default, fields with numeric suffices are not grouped into a single vtkDataArray. {"type":"boolean"} native initialisation / omitted false
MergeExodusEntityBlocks Set whether to merge entity blocks into a single block. This is useful only when the format is EXODUS. {"type":"boolean"} native initialisation / omitted false
NodeBlockFields Names of the nodal (point) fields to read, i.e. fields of the node block shared by every block and set, such as displacement, velocity or temperature. vtkIOSSReader enables all fields by default; listing names keeps only these. (The ParaView 5.13.3 XML text says "edge blocks" here, which is a copy error.) {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetFields Select the node sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSets Select the node sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ReadAllFilesToDetermineStructure When set to true (default), the reader will read all files to determine structure of the dataset because some files might have certain blocks that other files don't have. Set to false if you are sure that all files have the same structure, i.e. same blocks and sets. When set to false, the reader will only read the first file to determine the structure. which is faster than reading all files. {"type":"boolean"} native initialisation / omitted false
ReadGlobalFields When checked, the reader will read global fields, if available. {"type":"boolean"} native initialisation / omitted false
ReadIds When checked, the reader will read 'ids' and 'element_side' fields, if available. {"type":"boolean"} native initialisation / omitted false
ReadQAAndInformationRecords When checked, the reader will read quality assurance and information records, if available. {"type":"boolean"} native initialisation / omitted false
RemoveUnusedPoints Node related data, including point coordinates, point field data etc. is typically shared between all blocks and sets. By default, the reader will remove unused points for each block or set. To avoid this, set this flag to false. {"type":"boolean"} native initialisation / omitted false
ScanForRelatedFiles This reader can lookup additional related files using pattern matching based on the files provided. This is useful to lookup restarted results, for example. To avoid this behavior, uncheck this property. {"type":"boolean"} native initialisation / omitted false
SideSetFields Select the side sets fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSets Select the side sets to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StructuredBlockFields Select the structured blocks fields / arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StructuredBlocks Select the structured blocks to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIOSSReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvImageDataToAMR#

Converts a uniform image (vtkImageData, at least 2-D) into an overlapping AMR dataset (vtkOverlappingAMR). The input image is the finest level; coarser levels are generated from it with RefinementRatio between consecutive levels, and the hierarchy is split into at most MaximumNumberofBlocks blocks. No resolution is added. Use it to feed AMR operations such as pvExtractAMRBlocks, pvAMRContour or pvResampleAMR from image data.

Common mistakes and assumptions:

  • Each image dimension minus one must be divisible by RefinementRatio^(Numberoflevels − 1); e.g. 65 points per axis with ratio 2 allows up to 7 levels. Otherwise the filter fails with "Image cannot be refined".
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ImageDataToAMR. Identity: filters/ImageDataToAMR. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Data to Point Data filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MaximumNumberofBlocks This property specifies the maximum number of blocks in the output AMR data structure. {"maximum":100000,"minimum":1,"type":"integer"} native initialisation / omitted 1
Numberoflevels This property specifies the number of levels in the AMR data structure. {"maximum":20,"minimum":1,"type":"integer"} native initialisation / omitted 1
RefinementRatio Refinement ratio between consecutive AMR levels, an integer from 2 to 16. Schemaxis rejects 1 because VTK clamps the ratio to at least 2 (ParaView's own range starts at 1, so a value of 1 would silently run as 2 while still reading back as 1). {"maximum":16,"minimum":2,"type":"integer"} native initialisation / omitted 2

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvImageDataToAMR",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvImageDataToUniformGrid#

Converts image data (vtkImageData, or composite data whose leaves are images) into a vtkUniformGrid with blanking: a single-component point or cell array marks which points or cells are hidden. Values strictly between -1 and 1 (effectively zero) hide the element and other values keep it; Reverse swaps this. The blanking is written as a vtkGhostType array of hidden points or cells, which rendering and blanking-aware filters skip. Use it to mask solid or invalid regions of a regular grid without changing its structure.

Common mistakes and assumptions:

  • A value such as 0.5 counts as zero and is hidden; use a mask array of clear 0 and 1 values.
  • The array must have exactly one component; vector arrays are rejected.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ImageDataToUniformGrid. Identity: filters/ImageDataToUniformGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); image data (uniform rectilinear grids) (vtkImageData). The input needs at least one point- or cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkCompositeDataSet","vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Reverse Reverse the array value to whether or not a point or cell is blanked. {"type":"boolean"} native initialisation / omitted false
SelectInputScalars Specify the array to use for blanking. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvImageDataToUniformGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvImageDatatoPointSet#

Converts uniform image data (vtkImageData) into an equivalent structured grid with explicit point coordinates; point and cell arrays are kept. Use it before operations that move or need explicit points but reject image data, at the cost of storing coordinates.

Common mistakes and assumptions:

  • Output memory grows by three coordinates per point; avoid it on large volumes unless needed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ImageDatatoPointSet. Identity: filters/ImageDataToPointSet. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvImageDatatoPointSet",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvImageReader#

Reads headerless raw binary voxel files (.raw) into uniform image data. The file carries no metadata, so you describe it: DataExtent (index ranges), DataScalarType, DataByteOrder, NumberOfScalarComponents and FileDimensionality, plus DataSpacing and DataOrigin for world placement. Several files are a time series unless ReadAsImageStack stacks 2-D files as z slices. Use pvNrrdReader or pvMetaFileSeriesReader when a header file exists.

Common mistakes and assumptions:

  • DataExtent starts as all zeros, which describes a single voxel; always set it, e.g. [0, 255, 0, 255, 0, 99] for 256 x 256 x 100 voxels.
  • A wrong scalar type or byte order (ParaView defaults: short, BigEndian) still yields an image, only with nonsense values; check the value range after reading.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ImageReader. Identity: sources/ImageReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DataByteOrder This property indicates the byte order of the binary file(s). {"type":"enum","values":["BigEndian","LittleEndian"]} native initialisation / omitted "BigEndian"
DataExtent This property specifies the minimum and maximum index values of the data in each dimension (xmin, xmax, ymin, ymax, zmin, zmax). {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
DataOrigin The coordinate contained in this property specifies the position of the point with index (0,0,0). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
DataScalarType The value of this property indicates the scalar type of the pixels/voxels in the file(s): short, int, float ... {"type":"enum","values":["char","unsigned char","short","unsigned short","int","unsigned int","long","unsigned long","float","double"]} native initialisation / omitted "char"
DataSpacing This property specifies the size of a voxel in each dimension. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
FileDimensionality This property indicates whether the file(s) in this dataset contain slices (2D) or volumes (3D). {"type":"enum","values":["2","3"]} native initialisation / omitted "2"
FileLowerLeft This property determines whether the data originates in the lower left corner (on) or the upper left corner (off). Most scientific data is written with a right-handed axes that originates in the lower left corner. However, several 2D image file formats write the image from the upper left corner. {"type":"boolean"} native initialisation / omitted false
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
NumberOfScalarComponents This property specifies the number of components the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components). {"type":"integer"} native initialisation / omitted 1
ReadAsImageStack When set, the reader will read the set of files as an image stack, rather than a temporal file series. {"type":"boolean"} native initialisation / omitted false
ScalarArrayName This property contains a text string listing a name to assign to the point-centered data array read. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvImageReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvImageShrink#

Reduces the resolution of an image or volume (vtkImageData) by integer factors per axis, either by averaging each block of input pixels (ParaView default) or by keeping every nth pixel. The output spacing grows by the same factors. Use it to make large images manageable for preview or export; use resample or pvResampleToImage for non-integer target resolutions.

Common mistakes and assumptions:

  • Plain subsampling (Averaging false) can alias fine structure; keep averaging for continuous fields.
  • Averaging mixes values, so do not use it on label or mask images; switch Averaging off for those.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ImageShrink. Identity: filters/ImageShrink. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Image Shrink filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Averaging If the value of this property is 1, an average of neighborhood scalar values will be used as the output scalar value for each output point. If its value is 0, only subsampling will be performed, and the original scalar values at the points will be retained. {"type":"boolean"} native initialisation / omitted false
ShrinkFactors The value of this property indicates the amount by which to shrink along each axis. {"items":{"maximum":100,"minimum":1,"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvImageShrink",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvInSituParticlePath#

Parallel particle-path (pathline) tracer intended for in-situ use, e.g. inside a Catalyst pipeline that advances with a running simulation. Seeds from SeedSource are advected through the time-varying point vector field of Input; it adds options to clear the particle cache, keep advecting from previously computed particles (RestartSource) after a simulation restart, and start at FirstTimeStep. Output is polydata. For post-processing saved time series use pvParticlePath or pvParticleTracer.

Common mistakes and assumptions:

  • Particle paths need the pipeline to step through time; a single update at one time produces only the seeds.
  • The vector field must be point data; convert cell vectors with cellToPoint.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: InSituParticlePath. Identity: filters/InSituParticlePath. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
RestartSource Optional data input for the native RestartSource port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Specify the restart dataset. This is optional and can be used to have particle histories that were computed previously be included in this filter's computation. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ClearCache Clear the particle cache from previous time steps. {"type":"boolean"} native initialisation / omitted false
ComputeVorticity Compute vorticity and angular rotation of particles as they progress {"type":"boolean"} native initialisation / omitted false
DisableResetCache Prevents cache from getting reset so that new computation always start from previous results. {"type":"boolean"} native initialisation / omitted false
FirstTimeStep Set the first time step. Default is 0. {"type":"integer"} native initialisation / omitted 1
ForceReinjectionEveryNSteps When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
RestartedSimulation Specify whether or not this is a restarted simulation. {"type":"boolean"} native initialisation / omitted false
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds If the input seeds are not changing, then this can be set to 1 to avoid having to do a repeated grid search that would return the exact same result. {"type":"boolean"} native initialisation / omitted false
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
TerminationTime Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. The units of time should be consistent with the primary time variable. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvInSituParticlePath",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvIntegrateVariables#

Integrates every point and cell array over the input cells and sums the total length, area or volume; the output is a single point with one vertex cell holding the results. Only cells of the highest dimension present are used (with lines, triangles and hexahedra mixed, only the hexahedra count) and vertices are ignored. Same native filter as the curated integrate; use it for totals such as a surface-integrated flux or a volume-integrated quantity.

Common mistakes and assumptions:

  • Integrals are not averages: point-data integrals are never divided by the size; divide them yourself (calculator) or use DivideCellDataByVolume for cell data.
  • Vectors are integrated component by component; a flux needs a normal-component field on the surface, not the raw velocity.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: IntegrateVariables. Identity: filters/IntegrateAttributes. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Integrate Attributes filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DivideCellDataByVolume This option concerns the output cell data. If it is turned on, then each value in the output cell data will be divided by the total length/area/volume. If the dataset is distributed among MPI nodes, the total length/volume/area is is the sum of the individual total contributions from all pieces. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIntegrateVariables",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvInterpolatetoQuadraturePoints#

Interpolates every point array of the input to the quadrature points of each cell, using the selected quadrature offset array, and stores the results as field-data arrays of the same names (linked to the offset array); the mesh is unchanged. The quadrature tools work in sequence: pvGenerateQuadratureSchemeDictionary adds a cell offset array QuadratureOffset carrying the quadrature rules, pvInterpolatetoQuadraturePoints evaluates point fields at the quadrature points, and pvGenerateQuadraturePoints turns them into a point cloud.

Common mistakes and assumptions:

  • The input needs an offset array with a quadrature dictionary, normally from pvGenerateQuadratureSchemeDictionary; otherwise nothing is computed and ParaView only warns.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: InterpolatetoQuadraturePoints. Identity: filters/QuadraturePointInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
QuadratureSchemeDef Specifies the offset array from which we interpolate values to quadrature points. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvInterpolatetoQuadraturePoints",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvIntersectFragments#

Intersects material fragments with a plane, box or sphere. Input must be the fragment geometry and Source the fragment statistics (centres), i.e. output ports 0 and 1 of pvMaterialInterfaceFilter. Output port 0 is the intersection geometry and port 1 a point set approximating the centre of each fragment's cut. Use it to measure fragment cross-sections on a cutting surface.

Common mistakes and assumptions:

  • Connect the two pvMaterialInterfaceFilter ports explicitly with {"node": id, "port": 0} and {"node": id, "port": 1}; a plain node id selects port 0 for both.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: IntersectFragments. Identity: filters/IntersectFragments. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This input must contain fragment geometry. Accepted data: multiblock datasets (vtkMultiBlockDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This input must contain fragment centers. Accepted data: multiblock datasets (vtkMultiBlockDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType This property sets the type of intersecting geometry, and associated parameters. {"type":"typed proxy","choices":["Box","Plane","Sphere"]} native initialisation / omitted {"type":"Box"}

Nested SliceType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: implicit_functions/Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Bounds Reference box [xmin, xmax, ymin, ymax, zmin, zmax] used only when UseReferenceBounds is true; the box is then these bounds scaled by Length, rotated by Rotation and translated by Position, all about the coordinate origin, so Length [1, 1, 1], Rotation [0, 0, 0] and Position [0, 0, 0] reproduce Bounds exactly. Ignored otherwise. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
SliceType.options.Length With UseReferenceBounds false: edge lengths [Lx, Ly, Lz] of the box along its own axes (ParaView applies them as scale factors to a unit cube). With UseReferenceBounds true: dimensionless scale factors applied to the Bounds box about the coordinate origin. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Position With UseReferenceBounds false: world coordinates [x, y, z] of the box’s minimum corner (before rotation); the box extends from Position to Position + Length along its own axes. With UseReferenceBounds true: a translation applied to the transformed Bounds box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Rotation Rotation angles [rx, ry, rz] about the x, y and z axes, applied about the box’s local origin (its minimum corner at Position, not its centre; with UseReferenceBounds true, about the coordinate origin). The angles are combined in VTK’s Z-X-Y convention: the box transform is Translate · RotateZ · RotateX · RotateY · Scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.UseReferenceBounds Chooses how the box is defined. False: the box is a unit cube scaled by Length, rotated about its corner and placed at Position. True: the box starts from Bounds, and Length, Rotation and Position act as scale, rotation and translation relative to it (about the coordinate origin). {"type":"boolean"} native initialisation / omitted false

Nested SliceType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
SliceType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested SliceType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIntersectFragments",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvIsoVolume#

Keeps the part of the input where a scalar lies between the two bounds of ThresholdRange (inclusive), cutting cells exactly at both iso-values for point arrays; the output is an unstructured grid. Use it for the volume between two levels, e.g. 0.1 < alpha < 0.9 at a phase interface. Unlike threshold, which keeps or drops whole cells, it produces smooth boundaries.

Common mistakes and assumptions:

  • With a cell array, cells are kept or removed whole instead of being cut.
  • ParaView's static range is [0, 0], which keeps almost nothing; always set ThresholdRange.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: IsoVolume. Identity: filters/IsoVolume. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Threshold filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
InputScalars The value of this property contains the name of the scalar array from which to perform thresholding. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ThresholdRange The values of this property specify the upper and lower bounds of the thresholding operation. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvIsoVolume",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvJPEGSeriesReader#

Reads JPEG images (.jpg, .jpeg) into uniform image data with 8-bit greyscale or RGB point scalars. Several files are stacked into a 3-D volume by default (ReadAsImageStack true); set it false to read them as a time series. JPEG is lossy, so use it for photographs or rendered images rather than quantitative fields; pvPNGSeriesReader or pvTIFFSeriesReader keep exact values.

Common mistakes and assumptions:

  • JPEG stores no physical pixel size; set DataSpacing to place the image in world units.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: JPEGSeriesReader. Identity: sources/JPEGSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DataSpacing Set the spacing to use for the image output by this reader. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
ReadAsImageStack When set, the reader will read the set of files as an image stack, rather than a temporal file series. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvJPEGSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvKMeans#

Clusters observations into k groups (ParaView default 5) in the space spanned by the selected arrays, iterating until cluster centres move less than Tolerance or MaxIterations is reached. The model is the set of centres; assessment labels each point or cell with its nearest cluster and the distance to it, e.g. to segment flow regimes. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.

Common mistakes and assumptions:

  • Distances are Euclidean in raw array units, so variables with large magnitudes dominate; normalize them first (calculator).
  • Task 3 (Model and assess the same data) assesses data that also trained the model, which flatters the fit; prefer a separate data set via ModelInput.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: KMeans. Identity: filters/KMeans. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model. Accepted data: image data (uniform rectilinear grids) (vtkImageData); curvilinear structured grids (vtkStructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkStructuredGrid","vtkPolyData","vtkUnstructuredGrid","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
ModelInput Optional data input for the native ModelInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: A previously-calculated model with which to assess a separate dataset. This input is optional. Accepted data: tables (rows and columns) (vtkTable); multiblock datasets (vtkMultiBlockDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeMode Attribute association whose arrays are analysed; VariablesofInterest names are looked up in it. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
MaxIterations Specify the maximum number of iterations in which cluster centers are moved before the algorithm terminates. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Task Specify the task to be performed: modeling and/or assessment. <ol> <li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li> <li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li> <li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li> <li> "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset. The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.</li> </ol> When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The <i>Training fraction</i> setting will be ignored for tasks 1 and 3. {"type":"enum","values":["Detailed model of input data","Model a subset of the data","Assess the data with a model","Model and assess the same data"]} native initialisation / omitted "Detailed model of input data"
Tolerance Specify the relative tolerance that will cause early termination. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
TrainingFraction Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
k Specify the number of clusters. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvKMeans",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvLANLFOFSODHaloFinder#

LANL cosmology halo finder (vtkPLANLHaloFinder): it groups particles into friends-of-friends halos using a linking length in units of the interparticle spacing and, if SphereOverdensityHalosSOD is on, also computes spherical-overdensity (SOD) halo mass and radius around each large FOF halo. The input must carry point arrays velocity, mass, tag and ghost, as produced by pvCosmoReader. Port 0 returns the particles with a HaloID array; port 1 one point per halo with HaloMass, AverageVelocity, VelocityDispersion and, with SOD, the SOD arrays.

Common mistakes and assumptions:

  • GenericIO particle data lack the required velocity, mass, tag and ghost arrays; use pvANLHaloFinder for those.
  • Boxsize, Seedparticles and the mass thresholds must match the simulation; defaults are example values.
  • MBP and MCP centre finding can be very slow.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LANLFOFSODHaloFinder. Identity: filters/LANLHaloFinder. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Boxsize The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension (only positive positions are allowed in the input, or they are wrapped around). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Centerfinder Method used for computing the halo center. WARNING: Using MBP or MCP can be very slow. {"type":"enum","values":["Average position","Center of mass","Most Bound Particle (MBP)","Most Connected Particle (MCP)"]} native initialisation / omitted "Average position"
FOFmassthreshold Minimum FOF mass to calculate an SOD halo. {"type":"number"} native initialisation / omitted 1
FOFparticlethreshold Minimum number of particles (threshold) needed before a group is called a friends-of-friends (FOF) halo. {"minimum":1,"type":"integer"} native initialisation / omitted 1
FOFsizethreshold Minimum FOF halo size to calculate an SOD halo. {"minimum":0,"type":"integer"} native initialisation / omitted 0
InitialSODmass The initial SOD mass. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Linkinglength Linking length measured in units of interparticle spacing and is dimensionless. Used to link particles into halos for the friends-of-friends (FOF) algorithm. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Maximumradiusfactor Maximum radius factor for SOD finding. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Minimumradiusfactor Minimum radius factor for SOD finding. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Numberofbins Number of bins for SOD finding. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Overlap The space (in rL units) to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Seedparticles Number of seeded particles in one dimension. Therefore, total simulation particles is np^3 (cubed). {"minimum":0,"type":"integer"} native initialisation / omitted 0
SphereOverdensityHalosSOD If checked, spherical overdensity (SOD) halos will be calculated in addition to friends-of-friends (FOF) halos. {"type":"boolean"} native initialisation / omitted false
rho_c Specify the scale factor for rho_c (critical density) for SOD halo finding. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLANLFOFSODHaloFinder",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvLSDynaReader#

Reads an LS-DYNA d3plot database (the d3plot file and its numbered family files d3plot01, d3plot02… holding later states) as a time series. The output is a multiblock dataset with one unstructured-grid block per selected part, named after the part, carrying nodal arrays (e.g. Velocity, Acceleration) and per-element-type cell arrays (e.g. Stress, EffPlastStrn). Use it for crash, forming and impact results; select parts and arrays to limit memory.

Common mistakes and assumptions:

  • The mesh is deformed only when "Deflected Coordinates" is among PointArrays and DeformedMesh is true; the reader then also adds a Deflection displacement array.
  • Eroded elements are removed by default (RemoveDeletedCells), so cell counts change over time.
  • VTK notes that rigid-body and road-surface support is incomplete.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LSDynaReader. Identity: sources/LSDynaReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BeamArrays Select which beam arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
DeformedMesh When true, the output point coordinates are replaced by the deflected (current) coordinates at each time step, so the mesh moves with the solution; when false the mesh stays in its original position. This only works when the nodal array "Deflected Coordinates" is selected in PointArrays; the reader then also adds a "Deflection" displacement array either way. {"type":"boolean"} native initialisation / omitted false
FileName Set the file name for the LSDyna reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PartArrays Select which part arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ParticleArrays Select which particle arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Select which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RemoveDeletedCells Should cells that have been deleted (failed structurally, for example) be removed from the mesh? {"type":"boolean"} native initialisation / omitted false
RigidBodyArrays Select which rigid body arrays to load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RoadSurfaceArrays Select which road surface arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ShellArrays Select which shell arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SolidArrays Select which solid arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ThickShellArrays Select which thick shell arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLSDynaReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvLegacyParticlePath#

Legacy particle-path (pathline) tracer kept for compatibility with older ParaView states: it integrates particles from the SeedSource points through a time-dependent, point-centred velocity field and outputs polydata polylines, one per particle, up to the time at which the node is updated. Use it to follow fluid parcels in unsteady flow. For new work prefer pvParticlePath; for snapshot streamlines use streamTracer.

Common mistakes and assumptions:

  • The input must provide several time steps; with a single time step there is nothing to integrate.
  • Velocity must be a 3-component point array; convert cell data with cellToPoint first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LegacyParticlePath. Identity: filters/LegacyParticlePath. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Compute vorticity and angular rotation of particles as they progress {"type":"boolean"} native initialisation / omitted false
ForceReinjectionEveryNSteps When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds If the input seeds are not changing, then this can be set to 1 to avoid having to do a repeated grid search that would return the exact same result. {"type":"boolean"} native initialisation / omitted false
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
TerminationTime Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. The units of time should be consistent with the primary time variable. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLegacyParticlePath",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvLegacyStreakLine#

Legacy streakline tracer kept for compatibility with older ParaView states: particles are released from the SeedSource points at every step (reinjection every step by ParaView default) and advected through a time-dependent, point-centred velocity field; the output polydata connects all particles released from the same seed, like dye from a fixed injector. For new work prefer pvStreakLine; use pvLegacyParticlePath to follow individual particles.

Common mistakes and assumptions:

  • The input must provide several time steps; with a single time step there is nothing to integrate.
  • Velocity must be a 3-component point array; convert cell data with cellToPoint first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LegacyStreakLine. Identity: filters/LegacyStreakLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Compute vorticity and angular rotation of particles as they progress {"type":"boolean"} native initialisation / omitted false
DisableResetCache Prevents cache from getting reset so that new computation always start from previous results. {"type":"boolean"} native initialisation / omitted false
ForceReinjectionEveryNSteps When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds If the input seeds are not changing, then this can be set to 1 to avoid having to do a repeated grid search that would return the exact same result. {"type":"boolean"} native initialisation / omitted false
TerminationTime Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. The units of time should be consistent with the primary time variable. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLegacyStreakLine",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvLegacyVTKReader#

Reads a legacy-format VTK file (.vtk, ASCII or binary), the older single-file format that can hold structured points (image data), a structured, rectilinear or unstructured grid, or polydata, with point and cell arrays; the output type is whatever the file stores. Several file names form a time series, one file per step. Prefer the VTK XML readers (pvXMLPolyDataReader, pvXMLUnstructuredGridReader, …) for new data; use pvPartitionedLegacyVTKReader for a .pvtk set of pieces.

Common mistakes and assumptions:

  • List the files of a series in their intended time order; ParaView reads them in the order given.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: LegacyVTKReader. Identity: sources/LegacyVTKFileReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLegacyVTKReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvLevelScalarsOverlappingAMR#

Adds an array named LevelIdScalars holding the refinement level of each block of an overlapping AMR dataset, so refinement levels can be coloured or thresholded. The input must be vtkOverlappingAMR (e.g. from AMR readers); structure is unchanged. This is the old name of the same ParaView filter.

Common mistakes and assumptions:

  • ParaView 5.13 marks this proxy deprecated (renamed OverlappingAMRLevelIds, removal planned for 5.14); use pvOverlappingAMRLevelIds, which has the same behaviour and settings.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LevelScalarsOverlappingAMR. Identity: filters/OverlappingLevelIdScalars. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Level Scalars filter. Accepted data: overlapping AMR data (vtkOverlappingAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLevelScalarsOverlappingAMR",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvLine#

Creates a straight line from Point1 to Point2 as a polyline with intermediate points: either Resolution equal segments (UseRegularRefinement true, the default) or points at the fractions listed in RefinementRatios. Use it as a probe or seed line, a ruler-like annotation or a reference edge; to sample data along a line use probeLine.

Common mistakes and assumptions:

  • The output has only geometry (and texture coordinates); it samples nothing until used by a probe or resample operation.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Line. Identity: sources/LineSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Point1 This property controls the coordinates of the first endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property controls the coordinates of the second endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
RefinementRatios Specify refinements ration in the range [0.0, 1.0] where to add points along the line segment. 0.0 and 1.0 must be added to add the start and end points, if needed. {"items":{"maximum":1.0,"minimum":0.0,"type":"number"},"type":"array"} native initialisation / omitted [0.0]
Resolution This property specifies the number of pieces into which to divide the line. {"minimum":1,"type":"integer"} native initialisation / omitted 1
UseRegularRefinement If set, the line segment will be generated with regular subdivisions (specified by Resolution), else the subdivisions must be explicitly specified. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLine"
}

pvLinearCellExtrusion#

Extrudes every polygon of a polygonal surface independently into a 3-D cell (triangles to wedges, quads to hexahedra, other polygons to polyhedra) by a length equal to a cell scalar times ScaleFactor, along the cell normal or a user vector; the output is an unstructured grid. Use it for 3-D bar maps, e.g. building heights on a footprint map or values drawn as columns on a surface. Use pvLinearExtrusion to sweep the whole surface by one vector.

Common mistakes and assumptions:

  • Only polygons are extruded; vertices, lines and triangle strips are discarded.
  • The length array must be a single-component cell array.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LinearCellExtrusion. Identity: filters/LinearCellExtrusionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Linear Cell Extrusion filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MergeDuplicatePoints Remove duplicate points. {"type":"boolean"} native initialisation / omitted false
ScaleFactor Scale factor applied to the extrusion length. {"type":"number"} native initialisation / omitted 1
SelectInputScalars The array used to set the extrusion length. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
UseUserVector Use a custom extrusion direction. {"type":"boolean"} native initialisation / omitted false
UserVector Set the custom extrusion direction. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLinearCellExtrusion",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvLinearExtrusion#

Sweeps a polygonal dataset along one vector, creating side faces from its edges and, with Capping, copies of the polygons at both ends; output is polydata. Use it to turn a 2-D outline or planar surface into a prism-like solid surface, e.g. a profile into a constant-thickness part. Use pvLinearCellExtrusion for per-cell heights or volume cells.

Common mistakes and assumptions:

  • The result is a surface, not a volume mesh; mesh it separately if volume cells are needed.
  • Capping a closed surface duplicates it rather than building a solid; turning Capping off for a closed surface gives no output.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LinearExtrusion. Identity: filters/LinearExtrusionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Linear Extrusion filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Capping The value of this property indicates whether to cap the ends of the swept surface. Capping works by placing a copy of the input dataset on either end of the swept surface, so it behaves properly if the input is a 2D surface composed of filled polygons. If the input dataset is a closed solid (e.g., a sphere), then if capping is on (i.e., this property is set to 1), two copies of the data set will be displayed on output (the second translated from the first one along the specified vector). If instead capping is off (i.e., this property is set to 0), then an input closed solid will produce no output. {"type":"boolean"} native initialisation / omitted false
PieceInvariant The value of this property determines whether the output will be the same regardless of the number of processors used to compute the result. The difference is whether there are internal polygonal faces on the processor boundaries. A value of 1 will keep the results the same; a value of 0 will allow internal faces on processor boundaries. {"type":"boolean"} native initialisation / omitted false
ScaleFactor The value of this property determines the distance along the vector the dataset will be translated. (A scale factor of 0.5 will move the dataset half the length of the vector, and a scale factor of 2 will move it twice the vector's length.) {"type":"number"} native initialisation / omitted 1
Vector The value of this property indicates the X, Y, and Z components of the vector along which to sweep the input dataset. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLinearExtrusion",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvLocationSelectionSource#

Creates a location selection from world-space points. With FieldType CELL (the ParaView default) it selects the cells that contain each location; with POINT it selects mesh points located at each location. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. To sample interpolated values at a point instead, use pvExtractLocation or pvProbeLocation.

Common mistakes and assumptions:

  • With FieldType POINT the search radius is 0, so only a mesh point exactly at the location matches; use CELL selection or probing for arbitrary positions.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LocationSelectionSource. Identity: sources/LocationSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
Locations The list of locations that will be added to the selection produced by the selection source. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLocationSelectionSource"
}

Source that turns a texture resource into image data: it copies the texture's image (vtkImageData) with origin [0, 0, 0] and spacing 1, so pixel indices become coordinates. In ParaView it feeds the logo annotation; in Schemaxis its output can be published or processed like any image. Connect a pvResourceImageTexture or pvResourceTexture node to the Texture input; without one the output is empty.

Common mistakes and assumptions:

  • The image is placed in pixel units at the origin, not in your model's coordinates; scale or transform it if it must line up with other data.
  • Exercised by examples/schemaxis/paraview-textures.json (verification/2026-09-16-catalogue-expansion.json); other uses are unverified.

Native constructor: Logo. Identity: sources/LogoSource. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Texture Optional: the texture resource (a pvResourceTexture or pvResourceImageTexture node) used by the native Texture property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object texture {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"textures"}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLogo"
}

pvLoopSubdivision#

Refines a triangle surface with Loop's approximating subdivision: each pass splits every triangle into four and repositions points so the surface becomes smooth; point data are interpolated by the same scheme and new triangles inherit their parent's cell data. Use it to smooth coarse triangulated geometry for display. Input must be polydata of triangles only (run triangulate first). Because points move, the result no longer passes through the original vertices; use pvSubdivide for refinement that keeps the shape.

Common mistakes and assumptions:

  • Each pass quadruples the triangle count; NumberofSubdivisions 4 gives 256 times as many triangles.
  • Do not measure areas or volumes on the smoothed surface as if it were the original geometry.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: LoopSubdivision. Identity: filters/LoopSubdivisionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Loop Subdivision filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberofSubdivisions Set the number of subdivision iterations to perform. Each subdivision divides single triangles into four new triangles. {"maximum":4,"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvLoopSubdivision",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMFIXReader#

Reads MFIX multiphase-flow results: the restart file (.RES) supplies the cylindrical or rectilinear mesh, converted to an unstructured grid, and the SP* files beside it supply transient cell data, with one time step per stored output. Use it for MFIX gas-solid simulations; fields are cell-centred.

Common mistakes and assumptions:

  • Keep the SP* files in the same folder as the .RES file; only those found there are read.
  • Use cellToPoint before operations that need point data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: MFIXReader. Identity: sources/MFIXReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Select which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Set the file name for the MFIX reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMFIXReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvMPIMoveData#

ParaView-internal data-delivery filter that moves polydata, unstructured grids or AMR data between MPI processes and between data server, render server and client: PassThrough leaves data where they are, Collect gathers them to one process and Clone copies them to all. Its output type is PolyData unless OutputDataType says otherwise. It exists for ParaView's rendering pipeline; in Schemaxis prefer pvAppendReduce or pvReductionFilter to gather data.

Common mistakes and assumptions:

  • Omitted, OutputDataType is PolyData; set it to Unstructured Grid or ImageData to match inputs of those types.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MPIMoveData. Identity: filters/MPIMoveData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the MPI Move Data filter. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MoveMode Specify how the data is to be redistributed. {"type":"enum","values":["PassThrough","Collect","Clone"]} native initialisation / omitted "PassThrough"
OutputDataType The dataset type delivered. Omitted, it is PolyData, so set Unstructured Grid or ImageData when the input is of that type. {"type":"enum","values":["PolyData","Unstructured Grid","ImageData"]} native initialisation / omitted "PolyData"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMPIMoveData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMRCSeriesReader#

Reads MRC volumes (.mrc, also .st, .rec, .ali), the format of cryo-electron microscopy maps and tomograms, into uniform image data. Several files are read as a time series (one per step); this reader has no stacking option.

Common mistakes and assumptions:

  • Use one file per volume; several files are treated as time steps, not slices.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MRCSeriesReader. Identity: sources/MRCSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMRCSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvMandelbrot#

Generates image data whose float point scalar "Iterations" counts the iterations of z → z² + C before |z| exceeds 2 (capped at MaximumNumberofIterations). The 4-D parameter space (C real, C imaginary, X real, X imaginary, where X is the starting z) is sampled from OriginCX over SizeCX, with ProjectionAxes choosing which three parameters map to the image x, y and z axes. Use it as a synthetic image or volume with fine detail for testing.

Common mistakes and assumptions:

  • The native description calls the values unsigned char; VTK produces float values.
  • The output's origin and spacing are in Mandelbrot parameter units, not physical coordinates.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Mandelbrot. Identity: sources/ImageMandelbrotSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MaximumNumberofIterations The value of this property specifies the limit on computational iterations (i.e., the maximum number of iterations to perform to determine if the value will go above 2). Values less than 2.0 after the specified number of iterations are considered in the fractal set. {"maximum":5000,"minimum":1,"type":"integer"} native initialisation / omitted 1
OriginCX The four values of this property indicate (in order) the components of C (real and imaginary) and the components of the initial value, X (real and imaginary). {"items":{"type":"number"},"maxItems":4,"minItems":4,"type":"array"} native initialisation / omitted [1,1,1,1]
ProjectionAxes The three values in this property allow you to specify the projection from the 4D space used by the Mandelbrot set to the axes of the 3D volume. By default, the real component of C (represented by 0) is mapped to the X axis; the imaginary component of C (represented by 1) is mapped to the Y axis; and the real component of X, the initial value (represented by 2) is mapped to the Z axis. The imaginary component of X is represented by 3. All values entered must be between 0 and 3, inclusive. {"items":{"maximum":3,"minimum":0,"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [0,0,0]
SizeCX The four values of this property indicate the length of the output in each of the four dimensions (the real and imaginary components of C and the real and imaginary components of X). The three dimensions specified in the Projection Axes property will determine which of these values specify the length of the axes in the output. {"items":{"type":"number"},"maxItems":4,"minItems":4,"type":"array"} native initialisation / omitted [1,1,1,1]
SubsampleRate This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value. {"minimum":1,"type":"integer"} native initialisation / omitted 1
WholeExtent The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of 0, 250, 0, 250, 0, 0 indicate that the dimensions of the output will be 251 x 251 x 1. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMandelbrot"
}

pvMaskPoints#

Reduces a dataset to a subset of its points, output as polydata points (optionally with vertex cells) carrying the point data. By ParaView default it keeps every OnRatio-th point by point id (2), starting at Offset, until MaximumNumberofPoints (5000) is reached; random modes instead draw a random or spatially uniform sample. Use it to thin points before glyphs (arrows) or for lighter scatter exports.

Common mistakes and assumptions:

  • In the default striding mode the 5000-point cap is reached after the first 10000 point ids, so a large mesh is sampled only over part of its id range; raise MaximumNumberofPoints or use random sampling.
  • Without GenerateVertices (default false) the output has points but no cells, so it is not drawn and cell-based filters see nothing.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MaskPoints. Identity: filters/MaskPoints. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Mask Points filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateVertices This property specifies whether to generate vertex cells as the topography of the output. If set to 1, the geometry (vertices) will be displayed in the rendering window; otherwise no geometry will be displayed. {"type":"boolean"} native initialisation / omitted false
MaximumNumberofPoints The value of this property indicates the maximum number of points in the output dataset. {"minimum":0,"type":"integer"} native initialisation / omitted 0
Offset The value of this property indicates the starting point id in the ordered list of input points from which to start masking. {"minimum":0,"type":"integer"} native initialisation / omitted 0
OnRatio The value of this property specifies that every OnStride-th points will be retained in the output when not using Random (the skip or stride size for point ids). (For example, if the on ratio is 3, then the output will contain every 3rd point, up to the the maximum number of points.) {"minimum":1,"type":"integer"} native initialisation / omitted 1
ProportionallyDistributeMaximumNumberOfPoints When this is off, the maximum number of points is taken per processor when running in parallel (total number of points = number of processors * maximum number of points). When this is on, the maximum number of points is proportionally distributed across processors depending on the number of points per processor ("total number of points" is the same as "maximum number of points" maximum number of points per processor = number of points on a processor * maximum number of points / total number of points across all processors ). {"type":"boolean"} native initialisation / omitted false
RandomSampling If the value of this property is set to true, then the points in the output will be randomly selected from the input in various ways set by Random Mode; otherwise this filter will subsample point ids regularly. {"type":"boolean"} native initialisation / omitted false
RandomSamplingMode Randomized Id Strides picks points with random id increments starting at Offset (the output probably isn't a statistically random sample). Random Sampling generates a statistically random sample of the input, ignoring Offset (fast - O(sample size)). Spatially Stratified Random Sampling is a variant of random sampling that splits the points into equal sized spatial strata before randomly sampling (slow - O(N log N)). The Uniform Spatial Distribution (Bound based) samples points using random poisitions inside the bounds of the data set and a point locator. The Uniform Spatial Distribution (Surface Sampling) samples points randomly via an inverse transform on surface area of each cell (3D cells are ignored). The Uniform Spatial Distribution (Volume Sampling) samples points randomly sampled via an inverse transform on volume area of each cell (2D cells are ignored). {"type":"enum","values":["Randomized Id Strides","Random Sampling","Spatially Stratified Random Sampling","Uniform Spatial Distribution (Bounds Based)","Uniform Spatial Distribution (Surface Sampling)","Uniform Spatial Distribution (Volume Sampling)"]} native initialisation / omitted "Randomized Id Strides"
SingleVertexPerCell Tell filter to only generate one vertex per cell instead of multiple vertices in one cell. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMaskPoints",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMaterialInterfaceFilter#

Finds material fragments in AMR (hierarchical box) data such as CTH Spy Plot output: cells whose material fraction exceeds MaterialFractionThreshold are connected into fragments, whose surfaces form output port 0 (geometry) and whose centres of mass, volumes, masses and selected weighted averages form a point set on port 1 (statistics). It can invert the fraction and clip with a plane or sphere to measure craters, and can write both outputs to text files. Use pvRectilinearGridConnectivity for rectilinear multiblock data.

Common mistakes and assumptions:

  • Material fraction arrays are expected as unsigned char (the Spy Plot reader's down-conversion); float fractions are not offered for SelectMaterialFractionArrays.
  • Mass arrays pair with fraction arrays by list position; keep both lists in the same order.
  • WriteGeometryOutput and WriteStatisticsOutput write files outside Schemaxis-managed exports.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MaterialInterfaceFilter. Identity: filters/MaterialInterfaceFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Input to the filter can be a hierarchical box data set containing image data or a multiblock of rectilinear grids. Accepted data: non-overlapping AMR data (vtkNonOverlappingAMR). The input needs at least one cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkNonOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType This property sets the type of clip geometry, and associated parameters. {"type":"typed proxy","choices":["None","Plane","Sphere"]} native initialisation / omitted {"type":"None"}
ComputeOBB Compute Object Oriented Bounding boxes (OBB). When active the result of this computation is copied into the statistics output. In the case that the filter is built in its validation mode, the OBB's are rendered. {"type":"boolean"} native initialisation / omitted false
Computemassweightedaverageover For arrays selected a mass weighted average is computed. These arrays are also copied into fragment geometry cell data as the fragment surfaces are generated. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Computevolumeweightedaverageover For arrays selected a volume weighted average is computed. The values of these arrays are also copied into fragment geometry cell data as the fragment surfaces are generated. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
InvertVolumeFraction Inverting the volume fraction generates the negative of the material. It is useful for analyzing craters. {"type":"boolean"} native initialisation / omitted false
MaterialFractionThreshold Material fraction is defined as normalized amount of material per voxel. Any voxel in the input data set with a material fraction greater than this value is included in the output data set. {"maximum":1.0,"minimum":0.08,"type":"number"} native initialisation / omitted 0.08
OutputBaseName This property specifies the base including path of where to write the statistics and geometry output text files. It follows the pattern "/path/to/folder/and/file" here file has no extension, as the filter will generate a unique extension. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SelectMassArrays Mass arrays are paired with material fraction arrays. This means that the first selected material fraction array is paired with the first selected mass array, and so on sequentially. As the filter identifies voxels meeting the minimum material fraction threshold, these voxel's mass will be used in fragment center of mass and mass calculation. A warning is generated if no mass array is selected for an individual material fraction array. However, in that case the filter will run without issue because the statistics output can be generated using fragments' centers computed from axis aligned bounding boxes. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SelectMaterialFractionArrays Material fraction is defined as normalized amount of material per voxel. It is expected that arrays containing material fraction data has been down converted to a unsigned char. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteGeometryOutput If this property is set, then the geometry output is written to a text file. The file name will be constructed using the path in the "Output Base Name" widget. {"type":"boolean"} native initialisation / omitted false
WriteStatisticsOutput If this property is set, then the statistics output is written to a text file. The file name will be constructed using the path in the "Output Base Name" widget. {"type":"boolean"} native initialisation / omitted false

Nested ClipType → None#

Syntax: {"type":"None","options":{...}}. Native identity: implicit_functions/None. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested ClipType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
ClipType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested ClipType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ClipType.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ClipType.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMaterialInterfaceFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMedian#

Replaces each pixel or voxel of an image by the median of the selected array over a rectangular neighbourhood of KernelSize pixels, giving image data of the same size. Unlike a mean filter it removes isolated outliers (salt-and-pepper or shot noise) while keeping sharp edges. Each component is filtered separately. Near the image border the neighbourhood is clipped to the image.

Common mistakes and assumptions:

  • With the ParaView default kernel [1, 1, 1] nothing changes; set e.g. [3, 3, 1] for a 2-D image or [3, 3, 3] for a volume.
  • Even kernel sizes are off-centre and average the two middle values; prefer odd sizes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Median. Identity: filters/Median. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Median filter. Accepted data: image data (uniform rectilinear grids) (vtkImageData). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
KernelSize The value of this property specifies the number of pixels/voxels in each dimension to use in computing the median to assign to each pixel/voxel. If the kernel size in a particular dimension is 1, then the median will not be computed in that direction. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SelectInputScalars The value of this property lists the name of the scalar array to use in computing the median. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMedian",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMergeBlocks#

Full native Merge Blocks: appends the leaf datasets of a composite input into one dataset. OutputDataSetType decides the result: Unstructured Grid (ParaView default) merges blocks of any type, Polygonal Mesh merges only polydata blocks and leaves others out. MergePartitionsOnly keeps the block hierarchy and merges only the partitions within each block. Use merge for the common case (merge everything with point merging); use this when you need polydata output, a merge tolerance or partition-only merging.

Common mistakes and assumptions:

  • With Polygonal Mesh output, volume meshes and image blocks are silently omitted; extract their surfaces first if they must be included.
  • Tolerance is a fraction of the bounding-box diagonal unless ToleranceIsAbsolute is true.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MergeBlocks. Identity: filters/MergeBlocks. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input composite dataset. Accepted data: data-object trees (multiblock or partitioned) (vtkDataObjectTree). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObjectTree"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MergePartitionsOnly When set, only paritions and pieces will be merged into a dataset each, instead of merging everything into a single dataset. {"type":"boolean"} native initialisation / omitted false
MergePoints Merge points within a distance specified by the Tolerance property. {"type":"boolean"} native initialisation / omitted false
OutputDataSetType Determines the output type produced by this filter. Only blocks compatible with the output type will be merged in the output. For example, if the output type is "Polygonal Mesh", then blocks of type "Image Data", "Structured Grid", etc. will not be merged. If the output type is "UnstructuredGrid", then blocks of any type will be merged in the output. Defaults to "Unstructured Grid". {"type":"enum","values":["Polygonal Mesh","Unstructured Grid"]} native initialisation / omitted "Polygonal Mesh"
Tolerance Set the tolerance for merging points if Merge Points is enabled. {"type":"number"} native initialisation / omitted 1
ToleranceIsAbsolute This property determines whether to treat the Tolerance property as absolute (points closer than Tolerance are merged) or relative (points closer than a fraction of the input data's bounding box diagonal length) when performing point merging. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMergeBlocks",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMergeTime#

Combines several time-dependent inputs into one multiblock dataset (one block per input) whose time steps are the union of the inputs' times, or their intersection with Intersection on, with near-duplicates removed using Tolerance. For each requested time, every input supplies the matching step within tolerance, otherwise its last step before that time. Use it to view or export sources with different output times together.

Common mistakes and assumptions:

  • Inputs are not interpolated in time; a block may show an earlier step than the requested time.
  • Tolerance is absolute (in time units) unless RelativeTolerance is true.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MergeTime. Identity: filters/MergeTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: This property indicates the the inputs to the Group Datasets filter. Accepted data: any data object (vtkDataObject). True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Intersection Keep the intersection instead of the union of timesteps from each input. {"type":"boolean"} native initialisation / omitted false
RelativeTolerance Use Relative (resp. absolute) tolerance to determine if timesteps are duplicate. {"type":"boolean"} native initialisation / omitted false
Tolerance Tolerance used to determine if timesteps are duplicate. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMergeTime",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ]
  }
}

pvMergeVectorComponents#

Combines three single-component arrays of the same association (e.g. Ux, Uy, Uz from a solver that writes components separately) into one 3-component vector array named OutputVectorName; the dataset is otherwise unchanged. Use it before operations that need a vector field, such as glyphs, stream tracing or vorticity.

Common mistakes and assumptions:

  • The three arrays must have the same association (AttributeType, for example "Point Data" or "Cell Data") and one component each.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MergeVectorComponents. Identity: filters/MergeVectorComponents. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeType Association of the three component arrays and of the merged vector array. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data" or "Row Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data"]} native initialisation / omitted "Point Data"
OutputVectorName This property contains the name for the output vector containing the result of the merging. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
XArray This property indicates the name of the array with the X component. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
YArray This property indicates the name of the array with the Y component. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ZArray This property indicates the name of the array with the Z component. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMergeVectorComponents",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMeshQuality#

Adds a cell array Quality rating the shape of each cell with a Verdict metric chosen per cell type (triangle, quad, tetrahedron, pyramid, wedge, hexahedron); other cell types get 0. Use it to locate distorted or degenerate cells before a simulation or to explain solver problems. Each metric has its own scale and ideal value (for example Scaled Jacobian is 1 for an ideal element and negative for inverted ones), so read thresholds from the Verdict documentation. ParaView's defaults are Radius Ratio (triangles, tetrahedra), Edge Ratio (quads, wedges), Shape (pyramids) and Maximum Aspect Frobenius (hexahedra). Use pvCellSize or cellSize for cell size.

Common mistakes and assumptions:

  • On a mixed mesh the single Quality array holds different metrics for different cell types; compare values only within one cell type or choose comparable metrics.
  • Higher-order cells are measured by their own definition unless LinearApproximation is enabled, which adds Quality (Linear Approx).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MeshQuality. Identity: filters/MeshQuality. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Mesh Quality filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
HexQualityMeasure This property indicates which quality measure will be used to evaluate hexahedral quality. {"type":"enum","values":["Diagonal","Dimension","Distortion","Edge Ratio","Equiangle Skew","Jacobian","Maximum Edge Ratio","Maximum Aspect Frobenius","Mean Aspect Frobenius","Nodal Jacobian Ratio","Oddy","Relative Size Squared","Scaled Jacobian","Shape","Shape and Size","Shear","Shear and Size","Skew","Stretch","Taper","Volume"]} native initialisation / omitted "Diagonal"
LinearApproximation If turned on, then non-linear cells quantities will be computed by taking their linear approximate, i.e. ignoring their faces' curvature in a second output array named "Quality (Linear Approx)". {"type":"boolean"} native initialisation / omitted false
PyramidQualityMeasure This property indicates which quality measure will be used to evaluate pyramidal quality. {"type":"enum","values":["Equiangle Skew","Jacobian","Scaled Jacobian","Shape","Volume"]} native initialisation / omitted "Equiangle Skew"
QuadQualityMeasure This property indicates which quality measure will be used to evaluate quadrilateral quality. {"type":"enum","values":["Area","Aspect Ratio","Condition","Distortion","Edge Ratio","Equiangle Skew","Jacobian","Maximum Aspect Frobenius","Maximum Edge Ratio","Mean Aspect Frobenius","Minimum Angle","Oddy","Radius Ratio","Relative Size Squared","Scaled Jacobian","Shape","Shape and Size","Shear","Shear and Size","Skew","Stretch","Taper","Warpage"]} native initialisation / omitted "Area"
TetQualityMeasure This property indicates which quality measure will be used to evaluate tetrahedral quality. {"type":"enum","values":["Aspect Gamma","Aspect Frobenius","Aspect Ratio","Collapse Ratio","Condition","Distortion","Edge Ratio","Equiangle Skew","Equivolume Skew","Jacobian","Mean Ratio","Minimum Dihedral Angle","Normalized Inradius","Radius Ratio","Relative Size Squared","Scaled Jacobian","Shape","Shape and Size","Squish Index","Volume"]} native initialisation / omitted "Aspect Gamma"
TriangleQualityMeasure This property indicates which quality measure will be used to evaluate triangle quality. {"type":"enum","values":["Area","Aspect Ratio","Aspect Frobenius","Condition","Distortion","Edge Ratio","Equiangle Skew","Maximum Angle","Minimum Angle","Normalized Inradius","Radius Ratio","Relative Size Squared","Scaled Jacobian","Shape","Shape and Size"]} native initialisation / omitted "Area"
WedgeQualityMeasure This property indicates which quality measure will be used to evaluate wedge's quality. {"type":"enum","values":["Condition","Distortion","Edge Ratio","Equiangle Skew","Jacobian","Maximum Aspect Frobenius","Maximum Stretch","Mean Aspect Frobenius","Scaled Jacobian","Shape","Volume"]} native initialisation / omitted "Condition"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMeshQuality",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMetaFileSeriesReader#

Reads MetaImage files (.mhd header with a separate data file, or single-file .mha), common in ITK-based medical imaging and segmentation, into uniform image data; dimensions, spacing, origin and element type come from the header. Several files form a time series. pvWriteMetaImageWriter writes this format.

Common mistakes and assumptions:

  • For .mhd, the data file named in the header must stay beside it.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MetaFileSeriesReader. Identity: sources/MetaImageReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. Each file is expected to be in the meta format. The standard extension is .mhd. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMetaFileSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvMinMax#

Computes, for every point and cell array of the input, the componentwise minimum, maximum or sum over all tuples, and outputs a polydata with exactly one point and one vertex cell that carries the results under the original array names. Use it for one-number summaries such as peak temperature. In parallel runs ghost arrays are needed to avoid double counting. For cell-size-weighted totals use integrate; for distributions use pvHistogram.

Common mistakes and assumptions:

  • SUM adds raw tuple values; it is not an integral and ignores cell sizes.
  • Operation must be MIN, MAX or SUM in upper case; any other string makes the native filter report an error and fall back to MIN.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MinMax. Identity: filters/MinMax. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Min Max filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Operation Select whether to perform a min, max, or sum operation on the data. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMinMax",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMinkowskiFilter#

Computes Minkowski functionals and shapefinders for each polyhedral cell of a Voronoi tessellation (vtkMinkowskiFilter). It adds cell arrays S (surface area), V (volume, copied from the input's Volumes array), C (integrated mean curvature), X (Euler characteristic), G (genus), T = 3V/S (thickness), B = S/C (breadth), L = C/(4 pi (G + 1)) (length), and planarity P and filamentarity F, which characterize whether a structure is sheet-like or filament-like. Use it on merged Voronoi regions from pvVoronoiMergeConnected.

Common mistakes and assumptions:

  • Every cell must be a polyhedron and the input must have a Volumes cell array; other unstructured grids are not handled by the native code.
  • Lengths and areas are in the dataset's coordinate units; no conversion is applied.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MinkowskiFilter. Identity: filters/MinkowskiFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input for this filter. Accepted data: unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMinkowskiFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMoleculeToLines#

Converts a molecule (vtkMolecule) into polygonal data: each atom becomes a point and each bond a two-point line cell, with atom data copied to point data and bond data to cell data. Use it to process or export molecular structure with ordinary geometry operations, e.g. pvTube for stick models or a polydata writer. It reverses pvConvertIntoMolecule with line conversion on.

Common mistakes and assumptions:

  • Atoms without bonds become points with no cell, so cell-based operations and surface representations ignore them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MoleculeToLines. Identity: filters/MoleculeToLines. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: molecules (vtkMolecule). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMolecule"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMoleculeToLines",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvMotionFXCFGReader#

Reads a MotionFX .cfg motion definition: rigid-body motions (such as translation, rotation or planetary motion) applied to STL bodies listed in the file. The output is a temporal multiblock dataset with one block per body, positioned at each generated time step; TimeResolution sets how many steps cover the motion's time range. Use it to animate machine parts, e.g. gears or mixers, alongside simulation results.

Common mistakes and assumptions:

  • The STL files referenced by the CFG file must be present where the file expects them.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: MotionFXCFGReader. Identity: sources/MotionFXCFGReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName ASCII CFG file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
TimeResolution Specify the number of timesteps to generate in the animation. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMotionFXCFGReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvMultiResGenericIO#

Reads a multi-resolution set of HACC GenericIO files described by a JSON .gios file (vtkPMultiResolutionGenericIOReader). The file lists levels, each with time steps mapping times to GenericIO files; level 0 is the coarsest. The output is a multiblock with one block per level; without a streaming view requesting finer blocks only level 0 is loaded. Use pvGenericIOReader for a single resolution.

Common mistakes and assumptions:

  • Only the coarsest level is read in a Schemaxis batch run; finer levels stay empty.
  • ParaView marks it mpi_required; it has not been run by Schemaxis.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MultiResGenericIO. Identity: sources/MultiResGenericIO. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Path of the .gios JSON file: {"levels": [{"timesteps": [{"time": t, "file": "..."}]}]}, levels ordered from coarsest to finest. File paths inside it may be relative to the .gios file's folder; the .gios path itself is resolved from the Schemaxis process's working directory (in Studio, the launch directory). The value must be a constant. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ParticleData Names of the GenericIO variables to load as particle point arrays at every level (for example vx, vy, vz, id). Unlisted variables are not read; the coordinate variables are always read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
xAxis Name of the GenericIO variable used as the first (x) particle coordinate at every resolution level. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
yAxis Name of the GenericIO variable used as the second (y) particle coordinate at every resolution level. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
zAxis Name of the GenericIO variable used as the third (z) particle coordinate at every resolution level. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMultiResGenericIO",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvMulticorrelativeStatistics#

Computes the mean vector and covariance matrix (with its Cholesky decomposition) of the selected arrays, i.e. a multivariate Gaussian model, and assesses each observation by its squared Mahalanobis distance from the mean, useful for outlier detection across several correlated fields. Use pvPrincipalComponentAnalysis to add eigen-decomposition. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.

Common mistakes and assumptions:

  • The model tables are packed (upper triangle covariance, lower triangle Cholesky); read the operation reference before parsing them.
  • Task 3 (Model and assess the same data) assesses data that also trained the model, which flatters the fit; prefer a separate data set via ModelInput.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: MulticorrelativeStatistics. Identity: filters/MulticorrelativeStatistics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model. Accepted data: image data (uniform rectilinear grids) (vtkImageData); curvilinear structured grids (vtkStructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkStructuredGrid","vtkPolyData","vtkUnstructuredGrid","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
ModelInput Optional data input for the native ModelInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: A previously-calculated model with which to assess a separate dataset. This input is optional. Accepted data: tables (rows and columns) (vtkTable); multiblock datasets (vtkMultiBlockDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeMode Attribute association whose arrays are analysed; VariablesofInterest names are looked up in it. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
Task Specify the task to be performed: modeling and/or assessment. <ol> <li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li> <li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li> <li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li> <li> "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset. The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.</li> </ol> When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The <i>Training fraction</i> setting will be ignored for tasks 1 and 3. {"type":"enum","values":["Detailed model of input data","Model a subset of the data","Assess the data with a model","Model and assess the same data"]} native initialisation / omitted "Detailed model of input data"
TrainingFraction Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvMulticorrelativeStatistics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvNek5000Reader#

Reads Nek5000 spectral-element results through a .nek5000 metadata file that names the field-file template and the time steps. The output is an unstructured grid built from each spectral element's nodal points, with the selected fields as point arrays. Each element keeps its own copy of points shared with its neighbours unless MergePointstoCleangrid is enabled. This is a distributed reader.

Common mistakes and assumptions:

  • Without MergePointstoCleangrid neighbouring elements are not connected, so connectivity-based steps (surface extraction, connectivity) may see internal faces; merging fixes this but may use a lot of memory.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: Nek5000Reader. Identity: sources/Nek5000Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AddSpectralElementIdsasCellData Add Spectral Element Ids as cell-data (optional) {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the file name for the reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
MergePointstoCleangrid Clean the dataset by merging coincident points. May use a lot of memory. {"type":"boolean"} native initialisation / omitted false
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNek5000Reader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvNetCDFCAMreader#

Reads Community Atmosphere Model (CAM) output on an unstructured horizontal grid from two NetCDF files: FileName holds the points and fields and ConnectivityFileName the cell connectivity. The output is an unstructured grid that is unstructured horizontally and layered vertically: quadrilaterals for one layer, hexahedra when several layers are read. VerticalDimension chooses single-layer, midpoint (lev) or interface (ilev) variables; ParaView's default is midpoint layers. Use pvNetCDFReader for CF-convention gridded files.

Common mistakes and assumptions:

  • Both files are required; a connectivity file from a different grid gives wrong cells without an obvious error.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: NetCDFCAMreader. Identity: sources/NetCDFCAMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellLayerRight DEPRECATED in ParaView 4.4. No longer needed/supported. {"type":"boolean"} native initialisation / omitted false
ConnectivityFileName This property specifies the file name to read for the grid connectivity. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
InterfaceLayerIndex Specifies which layer to load from the interface layers. Note that the layer indexes 0 to n-1 map to Z values n-1 to 0. {"type":"integer"} native initialisation / omitted 1
MidpointLayerIndex Specifies which layer to load from the midpoint layers. Note that the layer indexes 0 to n-1 map to Z values n-1 to 0. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus This property lists which NetCDF CAM point variables to load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SingleInterfaceLayer Load only one layer from variables on the interface layers. The layer is specified by InterfaceLayerIndex. {"type":"boolean"} native initialisation / omitted false
SingleMidpointLayer Load only one layer from variables on the midpoint layers. The layer is specified by MidpointLayerIndex. {"type":"boolean"} native initialisation / omitted false
VerticalDimension Specify whether to read variables from the single layer, from midpoint layers or from interface layers. {"type":"enum","values":["Single layer [time, ncol]","Midpoint layers [time, lev, ncol]","Interface layers [time, ilev, ncol]"]} native initialisation / omitted "Single layer [time, ncol]"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetCDFCAMreader",
  "options": {
    "ConnectivityFileName": "REPLACE_WITH_VALUE",
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvNetCDFMPASreader#

Reads one MPAS (Model for Prediction Across Scales) NetCDF file on a global unstructured Voronoi mesh and builds its dual grid as an unstructured grid: MPAS cell variables become point data and vertex variables become cell data. By default it shows vertical level 0 on a sphere as ocean data; options give a multilayer view, a lat/lon projection or atmospheric layering. Edge-centred data and regional (planar) domains are not supported, and it is not a parallel reader.

Common mistakes and assumptions:

  • Additional dimensions (vertical level, tracer index) are fixed to one index per dimension; set ExtraDimensionIndices to choose the slice, or ShowMultilayerView to see all levels.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: NetCDFMPASreader. Identity: sources/MPASReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus This property lists which NetCDF dual-grid cell variables to load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CenterLongitude This property specifies where the center will be viewed for a lat/lon projection. {"type":"integer"} native initialisation / omitted 1
ExtraDimensionIndices Fixes the index of each additional NetCDF dimension of the selected variables (any dimension other than Time, nCells and nVertices, e.g. nVertLevels or a tracer dimension), so one slice is loaded. Give a flat list of [dimension name, index] pairs, with zero-based indices written as strings, e.g. ["nVertLevels", "5"]. In multilayer view the dimension named by VerticalDimension is read in full and its index is ignored. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the file name to read. It should be an MPAS format NetCDF file ending in .nc. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
IsAtmosphere This property indicates whether data is atmospheric. Checking this ensures the vertical levels will go up away from the sphere instead of down towards the center. {"type":"boolean"} native initialisation / omitted false
LayerThickness This property specifies how thick the layer should be if viewing the data in multilayer view. Each layer corresponds to a vertical level. A good starting point is 100,000 for the spherical view and 10 for the lat/lon projection. Click on -Z after applying this change, since the scale may change drastically. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus This property lists which NetCDF dual-grid point variables to load. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ProjectLatLon This property indicates whether to view the data in the lat/lon projection. {"type":"boolean"} native initialisation / omitted false
ShowMultilayerView This property indicates whether to show multiple layers in one view, with each vertical level having the same thickness, specified by the layer thickness slider. For ocean data, the layers correspond to data at vertical level whose number increases towards the center of the sphere. For atmospheric data, the layers correspond to data at vertical levels increasing away from the center. {"type":"boolean"} native initialisation / omitted false
UseDimensionedArrayNames This property ensures that the dimension info is always shown in the ParaView GUI. {"type":"boolean"} native initialisation / omitted false
VerticalDimension Name of the NetCDF dimension that represents vertical levels; the multilayer view (ShowMultilayerView) stacks one layer per index of this dimension. Change it for variables on another vertical dimension, such as interface levels (nVertLevelsP1 in MPAS files). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetCDFMPASreader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvNetCDFPOPreader#

Reads Parallel Ocean Program (POP) NetCDF output into a rectilinear grid. The NetCDF x, y, z order becomes the grid's z, y, x order, and z coordinates are negated so the first level is the highest (depth downwards). Only three-dimensional variables are offered; Stride subsamples the grid. Use pvNetCDFReader for general CF-convention files and pvParallelNetCDFPOPreader for the parallel variant.

Common mistakes and assumptions:

  • Index order is reversed relative to the NetCDF variable; apply Stride in grid (i, j, k) order.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: NetCDFPOPreader. Identity: sources/NetCDFPOPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Stride This property indicate the number of indices per dimension (i,j,k) to skip between each point included in this output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
VariableArrayStatus Names of the NetCDF variables to load as arrays on the rectilinear grid; only three-dimensional variables are offered by the reader. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetCDFPOPreader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvNetCDFReader#

Reads NetCDF files using the CF (and COARDS) conventions into structured VTK data: image data when nothing else is known, or rectilinear or curvilinear grids when CF coordinate metadata describes them; latitude/longitude grids can be shaped as a sphere (SphericalCoordinates). Dimensions chooses which group of variables (those sharing a dimension list) is loaded, and time comes from the CF time coordinate. Use it for climate, weather and ocean gridded data; use pvNetCDFCAMreader, pvNetCDFMPASreader or pvNetCDFPOPreader for those models' specific layouts.

Common mistakes and assumptions:

  • Only variables matching the chosen Dimensions are loaded; set Dimensions when the file mixes grids (e.g. 2-D surface and 3-D level variables).
  • Fill values stay as numbers unless ReplaceFillValueWithNan is on, which distorts ranges and averages.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: NetCDFReader. Identity: sources/netCDFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Dimensions Load the grid with the given dimensions. Any arrays that conform to these dimensions will be loaded. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileName The name of the files to load. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
OutputType Specifies the type of data that the reader creates. If Automatic, the reader will use the most appropriate grid type for the data read. Note that not all grid types support all data. A warning is issued if a mismatch occurs. {"type":"enum","values":["Automatic","Image","Rectilinear","Structured","Unstructured"]} native initialisation / omitted "Automatic"
ReplaceFillValueWithNan If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number (NaN) value. The advantage of setting these to NaN values is that, if implemented properly by the system and careful math operations are used, they can implicitly be ignored by calculations like finding the range of the values. That said, this option should be used with caution as VTK does not fully support NaN values and therefore odd calculations may occur. {"type":"boolean"} native initialisation / omitted false
SphericalCoordinates If on, then data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates. {"type":"boolean"} native initialisation / omitted false
VerticalBias The bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale + bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. The scaling will be adjusted if it results in invalid (negative) vertical values. {"type":"number"} native initialisation / omitted 1
VerticalScale The scale of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale + bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. The scaling will be adjusted if it results in invalid (negative) vertical values. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetCDFReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvNetCDFUGRIDreader#

Reads a NetCDF file that follows the UGRID conventions for unstructured meshes (used by some ocean, coastal and climate models) into an unstructured grid. vtkNetCDFUGRIDReader reads one 2-D mesh: mesh nodes become points and faces become cells (edges are not read), node variables become point arrays and face variables cell arrays, and a "time" variable provides time steps. Use pvNetCDFReader for CF-convention gridded NetCDF, pvNetCDFMPASreader for MPAS meshes or pvNetCDFPOPreader for POP ocean grids.

Common mistakes and assumptions:

  • ParaView's long help mentions a separate connectivity file, but ParaView 5.13.3 exposes no such property: the mesh topology and the data must be in the file given in FileName.
  • Only one 2-D mesh is read; edge-located variables and additional meshes in the file are not represented.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: NetCDFUGRIDreader. Identity: sources/NetCDFUGRIDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Face-located UGRID variables to load as cell arrays, for example a water level or depth stored on mesh faces. Variables not listed are not read; an empty list loads the mesh without face data. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Node-located UGRID variables to load as point arrays, for example a velocity component or bathymetry stored at mesh nodes. Variables not listed are not read; an empty list loads the mesh without node data. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ReplaceFillValueWithNan If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number (NaN) value. The advantage of setting these to NaN values is that, if implemented properly by the system and careful math operations are used, they can implicitly be ignored by calculations like finding the range of the values. That said, this option should be used with caution as VTK does not fully support NaN values and therefore odd calculations may occur. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetCDFUGRIDreader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvNetworkImageSource#

ParaView-internal source that reads an image file on one process and makes the image available on the client and render-server processes, used for textures and background images. In ReadFromMemory mode it instead fetches an image registered under TrivialProducerKey on the server. It is not a general network download. To read image data for analysis use readImageData or a pv image reader such as pvPNGSeriesReader.

Common mistakes and assumptions:

  • FileName is required by the Schemaxis binding even in ReadFromMemory mode.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: NetworkImageSource. Identity: sources/NetworkImageSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Set the name of image file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Mode Set the mode in which image data is read. {"type":"enum","values":["ReadFromFile","ReadFromMemory"]} native initialisation / omitted "ReadFromFile"
TrivialProducerKey Set the key used to locate the image data object on the server. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNetworkImageSource",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvNormalGlyphs#

ParaView's compound Normal Glyphs filter: extracts the outer surface, computes one normal per surface cell, and draws an arrow glyph at every cell centre along that normal. The output is polydata of arrows, typically rendered over the surface to check normal orientation, e.g. before extrusion, offsets or boundary-condition assignment. Arrow length is the glyph scale factor in dataset units; all arrows have the same size.

Common mistakes and assumptions:

  • Polygon ordering is used as found (Consistency is off in this filter by default), so mixed-orientation surfaces show arrows pointing both ways; that is often what you want to detect.
  • Every surface cell gets an arrow; on large surfaces decimate or extract a region first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: NormalGlyphs. Identity: filters/NormalGlyphs. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Consistency The value of this property controls whether consistent polygon ordering is enforced. Generally the normals for a data set should either all point inward or all point outward. If the value of this property is 1, then this filter will reorder the points of cells that whose normal vectors are oriented the opposite direction from the rest of those in the data set. {"type":"boolean"} native initialisation / omitted false
GlyphMaxPoints Native Glyph MaximumNumberOfSamplePoints, which caps the number of glyphs only in the Glyph filter's uniform-spatial-distribution modes. Normal Glyphs fixes its internal glyph mode to All Points, so this value does not limit the arrows here. {"type":"integer"} native initialisation / omitted 1
GlyphScaleFactor Length of every arrow in dataset coordinate units: the arrow source has unit length and no data array scales it, so this value is the displayed arrow length. Choose a few percent of the model size so arrows are visible without hiding the surface. {"type":"number"} native initialisation / omitted 1
InvertArrow Reverses the arrow geometry so each glyph points against the computed normal instead of along it. Use it when the surface normals point into the body and you want arrows outside; the normals themselves are unchanged. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 1,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNormalGlyphs",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvNrrdReader#

Reads NRRD images (.nrrd, or a detached .nhdr header with its data file or files) into uniform image data, taking dimensions, type and spacing from the header. vtkNrrdReader reads raw, ascii (also spelled txt or text) and gzip-compressed (gzip or gz) data; hex and bzip2 encodings are rejected with 'Unsupported encoding'. A detached header may name several data files only when each holds one 2-D slice of a 3-D volume. DataVOI loads a sub-box of a large volume.

Common mistakes and assumptions:

  • Re-save hex or bzip2 encoded NRRD files as raw or gzip before reading; the ParaView help text that calls ascii unsupported is out of date.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: NrrdReader. Identity: sources/NrrdReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DataVOI The data volume of interest (VOI). The VOI is a sub-extent of the data that you want loaded. Setting a VOI is useful when reading from a large data set and you are only interested in a small portion of the data. If left containing all 0's, then the reader will load in the entire data set. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
FileName The name of the file to read (or the meta data file that will point to the actual file). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvNrrdReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvOMETIFFChannelCalculator#

Combines up to ten fluorescence-microscopy channels of an OME-TIFF image into one RGBA colour image. Each enabled point array named Channel_1 to Channel_10 (the names pvOMETIFFReader produces) is mapped through its ChannelNLUT lookup table, its opacity is multiplied by ChannelNWeight, and the channels are blended additively into a new unsigned-char point array named Colors; the input image and its arrays are passed through unchanged. Use it to make a false-colour composite for display or PNG export; the channel data themselves are not modified.

Common mistakes and assumptions:

  • Every enabled channel needs a lookup table: an enabled array without a ChannelNLUT stops the filter with "No LUT specified". Connect a pvResourcePVLookupTable to the matching ChannelNLUT input (opacity mapping on) for each channel you enable.
  • Lookup tables and weights are keyed by the names Channel_1 to Channel_10; arrays with other names cannot be given a lookup table.
  • ParaView's GUI creates default colour maps (blue, green, red, magenta, cyan, grey) when the proxy is initialized with input data available; Schemaxis has not verified that this happens for its nodes, so connect the tables explicitly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OMETIFFChannelCalculator. Identity: filters/OMETIFFChannelCalculator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Channel10LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel10LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel1LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel1LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel2LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel2LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel3LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel3LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel4LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel4LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel5LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel5LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel6LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel6LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel7LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel7LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel8LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel8LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Channel9LUT Optional: the colour lookup-table resource (a pvResourcePVLookupTable node) used by the native Channel9LUT property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Channel10Weight Multiplier applied to the opacity that Channel10LUT gives each pixel of the array Channel_10, before that channel is added into the Colors composite. Larger values make channel 10 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel1Weight Multiplier applied to the opacity that Channel1LUT gives each pixel of the array Channel_1, before that channel is added into the Colors composite. Larger values make channel 1 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel2Weight Multiplier applied to the opacity that Channel2LUT gives each pixel of the array Channel_2, before that channel is added into the Colors composite. Larger values make channel 2 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel3Weight Multiplier applied to the opacity that Channel3LUT gives each pixel of the array Channel_3, before that channel is added into the Colors composite. Larger values make channel 3 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel4Weight Multiplier applied to the opacity that Channel4LUT gives each pixel of the array Channel_4, before that channel is added into the Colors composite. Larger values make channel 4 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel5Weight Multiplier applied to the opacity that Channel5LUT gives each pixel of the array Channel_5, before that channel is added into the Colors composite. Larger values make channel 5 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel6Weight Multiplier applied to the opacity that Channel6LUT gives each pixel of the array Channel_6, before that channel is added into the Colors composite. Larger values make channel 6 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel7Weight Multiplier applied to the opacity that Channel7LUT gives each pixel of the array Channel_7, before that channel is added into the Colors composite. Larger values make channel 7 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel8Weight Multiplier applied to the opacity that Channel8LUT gives each pixel of the array Channel_8, before that channel is added into the Colors composite. Larger values make channel 8 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
Channel9Weight Multiplier applied to the opacity that Channel9LUT gives each pixel of the array Channel_9, before that channel is added into the Colors composite. Larger values make channel 9 more prominent; 0 removes its contribution while keeping it enabled. Colour components are clamped to [0, 1] after blending. {"type":"number"} native initialisation / omitted 1
ChannelVisibilities Select the point data arrays to pass through {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOMETIFFChannelCalculator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOMETIFFReader#

Reads an OME-TIFF microscopy file (.ome.tif, .ome.tiff), using its OME-XML metadata to split the TIFF pages into z-planes, channels and time steps; the output is uniform image data with time steps. Only single-file, multi-page OME-TIFF is supported. Use pvOMETIFFChannelCalculator downstream to combine channels, or pvTIFFSeriesReader for plain TIFF.

Common mistakes and assumptions:

  • Multi-file OME-TIFF datasets are not read correctly; use the single-file form.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OMETIFFReader. Identity: sources/OMETIFFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CustomDataSpacing Set the spacing to use for the image output by this reader. This is used only when UseCustomDataSpacing is set to 1. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
FileName This property specifies the file name for the OME-TIFF reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
IgnoreColorMap When checked, data values in the TIFF file will not be mapped to colors using the color map specified in the TIFF, if any. This is useful for files where the color map may be incorrectly specified. {"type":"boolean"} native initialisation / omitted false
UseCustomDataSpacing To manually specify a custom spacing using CustomDataSpacing, set this property to 1 (checked). {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOMETIFFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvOMFReader#

Reads an Open Mining Format (.omf) project into a partitioned dataset collection with one entry per selected element: point sets (e.g. drill-hole samples), line sets, surfaces and block-model volumes, with their attribute data. Use it for geological and mining models. Elements are not loaded unless selected in DataElements.

Common mistakes and assumptions:

  • VTK disables every element by default, so list the elements you need in DataElements or the output may be empty.
  • If block-model volumes look scrambled, the file was written column-major; enable ColumnMajorOrdering.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: OMFReader. Identity: sources/OMFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColumnMajorOrdering Are volumes written in column major data order as opposed to standard row major order. {"type":"boolean"} native initialisation / omitted false
DataElements Select which data elements to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property sets the OMF file to be read. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOMFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvObjectFileFormatOFFReader#

Reads Object File Format geometry (.off: vertex list followed by polygon faces) into polydata with polygons and lines. Use it for meshes from geometry-processing tools; for CAD surfaces in STL or OBJ use readSTL/pvSTLReader or pvWavefrontOBJReader.

Common mistakes and assumptions:

  • The format carries no units or field arrays; coordinates are used as written.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: ObjectFileFormatOFFReader. Identity: sources/offreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the OFF reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvObjectFileFormatOFFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvOctreeImagetoPointSet#

Reverses pvPointSetToOctreeImage: reads an image whose cell scalars are the unsigned-char "octree" bit mask and emits polydata with one point for every set bit, placed at the centre of the corresponding octant of the cell (a quarter of the spacing from the cell centre). It can also copy one component of a chosen cell array to the generated points. Use it to rebuild an approximate point cloud from a compact octree image; positions are quantized to octants, so original coordinates are not recovered.

Common mistakes and assumptions:

  • The active cell scalars must be the unsigned-char octree mask produced by pvPointSetToOctreeImage (array "octree"); other images give meaningless points.
  • pvPointSetToOctreeImage outputs a partitioned dataset holding one image; if this filter rejects it, extract the image block first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OctreeImagetoPointSet. Identity: filters/OctreeImageToPointSet. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArray The value of this property contains the name of the cell array to be processed. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
Component The value of this property specifies the array component that will be extracted from the cell array. {"type":"integer"} native initialisation / omitted 1
CreateVerticesCellArray Set whether a cell array of vertices will be created. {"type":"boolean"} native initialisation / omitted false
ProcessInputCellArray Set if input cell array should be processed. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOctreeImagetoPointSet",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOpenFOAMReader#

Full native OpenFOAM reader: opens a case through its .foam marker and outputs a multiblock dataset with the selected mesh regions (internalMesh, patches, patch groups, Lagrangian clouds and optionally zones) carrying cell, point and Lagrangian fields for each stored time. Omitted settings keep ParaView's own defaults: Reconstructed Case, the 0 directory skipped, point data interpolated from cell fields, 32-bit labels and 64-bit scalars. Use the curated foam operation for the common case (decomposed case, internalMesh only, 0 kept); use this one for point or Lagrangian fields, zones, binary label/scalar sizes and the other native options.

Common mistakes and assumptions:

  • SkipZeroTime is true by ParaView default, so the initial conditions in 0/ are not offered as a time; set it false to inspect them.
  • For binary cases, LabelSize and ScalarSize must match how OpenFOAM was built (e.g. 64-bit labels); a mismatch misreads the files.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: OpenFOAMReader. Identity: sources/OpenFOAMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Adddimensionalunitstoarraynames Read dimensional units from field data and add them to array names as human-readable string. {"type":"boolean"} native initialisation / omitted false
Cachemesh Cache the OpenFOAM mesh between GUI selection changes. {"type":"boolean"} native initialisation / omitted false
CaseType The property indicates whether decomposed mesh or reconstructed mesh should be read {"type":"enum","values":["Decomposed Case","Reconstructed Case"]} native initialisation / omitted "Decomposed Case"
CellArrays Cell-centred fields to read from the time directories (OpenFOAM volume fields such as p, U, T, k or nut). Fields not listed are not loaded; an empty list loads the mesh without cell fields. With Createcelltopointfiltereddata on (ParaView default) each selected field is also interpolated to points. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Copydatatocellzones Copy data of internal mesh to the cell zones {"type":"boolean"} native initialisation / omitted false
Createcelltopointfiltereddata Create point data from cell data. Beware: the filter does not do inverse distance weighting. {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the file name for the reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
LabelSize The expected label-size for the OpenFOAM data. {"type":"enum","values":["32-bit","64-bit"]} native initialisation / omitted "32-bit"
LagrangianArrays Fields of Lagrangian particle clouds (files under <time>/lagrangian/<cloud>/, such as d for diameter or U for particle velocity) to attach to the particle points. They appear only for clouds whose lagrangian/<cloud> region is selected in MeshRegions. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Lagrangianpositionswithoutextradata Lagrangian positions without extra data (before OpenFOAM 1.4, after 2.4) {"type":"boolean"} native initialisation / omitted false
ListtimestepsaccordingtocontrolDict List time directories listed according to the settings in controlDict. {"type":"boolean"} native initialisation / omitted false
MeshRegions Mesh parts to load, each becoming a block: internalMesh (volume cells), patch/<name> boundaries, group/<name> patch groups and lagrangian/<cloud> particle clouds; with Readzones on, zones are offered too. Multi-region cases prefix names with /<region>/. Loading fewer regions reduces memory and read time. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Point fields stored by the case itself (OpenFOAM point fields, e.g. pointDisplacement in moving-mesh cases). These are not the interpolated point data created from cell fields by Createcelltopointfiltereddata, which needs no selection here. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Readzones Read point/face/cell-Zones? {"type":"boolean"} native initialisation / omitted false
ScalarSize The expected scalar-size for the OpenFOAM data. {"type":"enum","values":["32-bit (SP)","64-bit (DP)"]} native initialisation / omitted "32-bit (SP)"
SkipZeroTime Ignore the 0/ time directory. {"type":"boolean"} native initialisation / omitted false
WeightPointDataByCellSize Use cell size as weight in cell data-to-point data procedure. {"type":"boolean"} native initialisation / omitted false

onVisit commands:

{
  "Refresh": {
    "command": "SetRefresh",
    "native": "Refresh"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOpenFOAMReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["Refresh"]. Commands run in this authored order before the update.

pvOpenVDBReader#

Reads an OpenVDB (.vdb) file, the sparse volume format used in visual effects and some simulation tools. Each grid becomes a block of a partitioned dataset collection: volume grids become image data (vtkImageData) and point grids become polydata vertices. MergeImageVolumes or MergePointSets instead combine the selected grids into one image (one array per grid) or one point set, and DownsamplingFactor coarsens the sampled volume.

Common mistakes and assumptions:

  • Sparse volumes are sampled onto a dense image, so a large sparse grid can need much more memory than the file size suggests; try DownsamplingFactor 0.5 for a first look.
  • Without merging each grid is a separate block; enable MergeImageVolumes when a later operation needs one image with several arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: OpenVDBReader. Identity: sources/OpenVDBReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DownsamplingFactor This parameter controls the sampling rate of the image volume. A value of 1 will lead to a volume with the same resolution as the read one. A value of 0.5 will downsample the file by half along each axis. {"maximum":1.0,"minimum":0.05,"type":"number"} native initialisation / omitted 0.05
FileName This property specifies the file name for the OpenVDB Reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
GridArrays This property lists which grid arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MergeImageVolumes When enabled, the different requested image grids will be merged into a single ImageData. When disabled, the different requested image grids will be stored into individual blocks. {"type":"boolean"} native initialisation / omitted false
MergePointSets When enabled, the different requested point clouds will be merged into a single PolyData. When disabled, the different requested point clouds will be stored into individual blocks. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOpenVDBReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvOutline#

Produces the 12 edges of the input's axis-aligned bounding box as polydata lines, a lightweight frame for images of volumes or point clouds; in MPI runs the global bounds are used. Same native filter as the curated outline (neither has options). Accepts datasets and graphs; use pvOutlineCorners to draw only the corners.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Outline. Identity: filters/OutlineFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Outline filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); graphs (vertices and edges) (vtkGraph). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOutline",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOutlineCorners#

Draws only the corners of the input's axis-aligned bounding box, as short segments running from each corner along the three box edges, for a less cluttered frame than pvOutline. CornerFactor sets each segment's length as a fraction of the box size along that axis.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OutlineCorners. Identity: filters/OutlineCornerFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Outline Corners filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CornerFactor Length of each corner segment as a fraction of the bounding-box size along that axis: 0.2 draws segments one fifth of the box edge long, and 0.5 joins them into a full outline. {"maximum":0.5,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOutlineCorners",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOutlineCurvilinearDataSet#

Draws the 12 boundary edges of a structured (curvilinear) grid as polydata lines that follow the grid's curved outer edges instead of its axis-aligned bounding box. Input must be a vtkStructuredGrid. Use it to show the extent of a body-fitted CFD block; outline or pvOutline draw a bounding-box outline of any dataset.

Common mistakes and assumptions:

  • Unstructured or image inputs are rejected; for those use outline.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OutlineCurvilinearDataSet. Identity: filters/StructuredGridOutlineFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the outline (curvilinear) filter. Accepted data: curvilinear structured grids (vtkStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOutlineCurvilinearDataSet",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOutlineSource#

Creates the twelve edges of an axis-aligned box as line polydata from explicit Bounds [xmin, xmax, ymin, ymax, zmin, zmax]. Use it to draw a region of interest or a fixed reference box in a scene; to outline the bounds of existing data use outline, and for a solid box use pvBox.

Common mistakes and assumptions:

  • The edges are lines only; there are no faces to slice or clip against.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: OutlineSource. Identity: sources/OutlineSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Bounds The values of this property specify the minimum and maximum X, Y, and Z coordinates (X min, X max, Y min, Y max, Z min, Z max) for drawing the outline. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOutlineSource"
}

pvOverlappingAMRLevelIds#

Adds an array named LevelIdScalars holding the refinement level of each block of an overlapping AMR dataset, so refinement levels can be coloured or thresholded. The input must be vtkOverlappingAMR (e.g. from AMR readers); structure is unchanged.

Common mistakes and assumptions:

  • Ordinary multiblock or unstructured data are rejected; use pvBlockIds for block indices.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OverlappingAMRLevelIds. Identity: filters/OverlappingAMRLevelIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Level Scalars filter. Accepted data: overlapping AMR data (vtkOverlappingAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOverlappingAMRLevelIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvOverlappingCellsDetector#

Detects cells that overlap other cells of the same mesh and adds a cell array, NumberOfOverlapsPerCell, counting for each cell how many other cells it collides with (the upstream description's name NumberOfCollisionsPerCell is outdated). Use it as a mesh-quality check, e.g. for overlapping overset regions or badly merged parts; zero everywhere means no overlap was found. It accepts point sets and composite data and works across MPI processes.

Common mistakes and assumptions:

  • Tolerance is a length: each cell is shrunk by half of it before testing, so contacts within that margin are ignored; too large a value hides genuine overlaps.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: OverlappingCellsDetector. Identity: filters/OverlappingCellsDetector. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Tolerance Cells are deflated by 0.5 * Tolerance before the cell overlaps are computed. Deflating is done by translating each cell's faces and edges, in their normal direction, by a vector of norm Tolerance. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvOverlappingCellsDetector",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPCANormalEstimation#

Estimates a normal at every point of a polydata point cloud by principal component analysis: a plane is fitted to each point's neighbours and its normal is stored in the point array PCANormals. Use it for scanned or particle data without connectivity, where surface normals cannot be computed from polygons (use normals or pvGenerateSurfaceNormals for meshed surfaces). The neighbourhood is chosen by SearchMode, SampleSize and Radius; the sign of each normal is arbitrary unless NormalOrientation fixes it.

Common mistakes and assumptions:

  • With the ParaView default orientation As Computed, neighbouring normals can point to opposite sides of the surface; choose Point or Graph Traversal when shading or offsets depend on a consistent side.
  • Input must be polydata; convert other datasets with pvConvertToPointCloud first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PCANormalEstimation. Identity: filters/PCANormalEstimation. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input from which the normals are estimated. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FlipNormals Flip the normals. {"type":"boolean"} native initialisation / omitted false
NormalOrientation Orientation mode of the normals. {"type":"enum","values":["As Computed","Point","Graph Traversal"]} native initialisation / omitted "As Computed"
OrientationPoint Point used to orient the normals. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Radius Radius of the sphere to use for the search of nearest neighbors. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
SampleSize Number of points to sample for PCA. {"minimum":0,"type":"integer"} native initialisation / omitted 0
SearchMode Configure how the filter selects the neighbor points used to calculate the PCA. With KNN mode K (SampleSize) points are selected regardless of their location relative to the sampled point. The radius can also be set to ensure that a sufficiently large neighborhood is taken into account, if not (i.e. all points fall inside the radius), the second approach is performed. With Radius mode, neighboring points are selected inside a radius (RADIUS), only the neighborhood of the sampled point is considered. If K (SampleSize) is also set, the number of points found inside the radius must be larger than K, if not the first approach is performed. Both approaches give the same results. The first approach is faster for uniform point clouds, in other cases, the second approach is faster. {"type":"enum","values":["KNN","Radius"]} native initialisation / omitted "KNN"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPCANormalEstimation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPDALReader#

Reads LiDAR and other point-cloud files through the PDAL library (LAS/LAZ, PCD, PLY, text and the other formats PDAL supports) into polydata points with per-point attribute arrays such as Intensity, Classification and colour. Use it for terrain, building or vegetation scans; follow it with pvPCANormalEstimation or pvGaussianResampling to derive normals or density fields.

Common mistakes and assumptions:

  • Coordinates are kept as stored (often large projected values); nothing is reprojected or shifted.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: PDALReader. Identity: sources/PDALReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the PDAL reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPDALReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPDBReader#

Reads a Protein Data Bank file (.pdb) of macromolecular structure into polydata: atoms as points with arrays such as atom_type, residue, chain and secondary_structures, and bonds as lines estimated from atomic distances. Recent VTK sources also provide a vtkMolecule on output port 1. Use it for protein or nucleic-acid structures; pvXYZReader suits simple coordinate lists.

Common mistakes and assumptions:

  • Bonds are estimated from interatomic distances with fixed scaling factors, so verify unusual geometries.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: PDBReader. Identity: sources/pdbreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the PDB reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPDBReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPIOReader#

Reads xRAGE PIO dump files (Los Alamos radiation-hydrodynamics code) through an ASCII .pio file describing the dump directory, cycles and variables. AMR data become an unstructured grid of cells or, with UseHyperTreeGridHTGforAMRMesh, a hypertree grid; the selected variables are cell arrays. LoadTracers adds tracer particles as a second unstructured grid, and TimeArray chooses the field used as time (ParaView default SimulationTime). This is a distributed reader.

Common mistakes and assumptions:

  • Variables are cell-centred; use cellToPoint before operations that need point data.
  • Hypertree-grid output is accepted only by hypertree-grid-aware filters; keep the default unstructured grid for general filters or convert with pvHyperTreeGridToUnstructuredGrid.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: PIOReader. Identity: sources/PIOReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Variables written to the data files are described in the .pio file and are presented for selection. Only selected variables are loaded for a time step. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName ASCII .pio file describes locations of data files, type and order of data written to the files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
LoadTracers This property determines if tracer data is read into a second unstructured grid. {"type":"boolean"} native initialisation / omitted false
LoadvariablesasdoublesFloat64 This property determines if the AMR and tracer variable data is read as 64 bit float. {"type":"boolean"} native initialisation / omitted false
TimeArray Chooses which value labels each time step: SimulationTime (ParaView's XML default), CycleIndex or PIOFileIndex; any other entry, including "None", numbers the steps with the integers 0, 1, 2, ... ParaView's own description calls the no-selection entry "Default", but the list's entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
UseHyperTreeGridHTGforAMRMesh This property determines if AMR in the PIO file is created as a hypertree grid rather than as an unstructured grid. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPIOReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPLOT3DMetaFileReader#

Reads a PLOT3D case through a .p3d meta file: a small JSON file naming the grid (.xyz), solution (.q) and optional function files for each time value, and recording the format settings PLOT3D files do not describe themselves (binary or ASCII, byte order, precision, multi-grid, Fortran byte counts, blanking, 2-D, R, gamma, derived functions). The output is a multiblock dataset of structured grids. Use it for time series or to keep format settings with the data; use pvPLOT3DReader to set the format in the node instead.

Common mistakes and assumptions:

  • Relative file names inside the meta file are resolved from the meta file's folder, not from the Schemaxis working directory.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: PLOT3DMetaFileReader. Identity: sources/Plot3DMetaReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the meta file name Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPLOT3DMetaFileReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPLOT3DReader#

Reads NASA PLOT3D structured-grid data: a grid file (.xyz) with block coordinates, solution files (.q) holding density, momentum and stagnation energy, and a function file (.f) of extra variables. The output is a multiblock dataset of structured grids with density, momentum and stagnation energy as point arrays; Functions adds derived quantities (pressure, Mach number, velocity, vorticity …) computed with the reader's gas constants R = 1.0 and γ = 1.4, which are not exposed here. Several .q files form a time series. Use pvPLOT3DMetaFileReader when a .p3d meta file describes the case.

Common mistakes and assumptions:

  • PLOT3D files are not self-describing: when AutoDetectFormat (ParaView default true) cannot work, e.g. for ASCII files, set BinaryFile, ByteOrder, DoublePrecision, MultiGrid, HasByteCount, IBlanking and TwoDimensionalGeometry to match the writer.
  • FunctionFileName and QFileName are optional: leave them out to read the grid file alone. The native reader skips an empty solution or function file name, so a grid-only case is valid and produces no solution arrays.
  • Check that R = 1.0 and γ = 1.4 match your solver's normalization before interpreting derived pressure, temperature or Mach number.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: PLOT3DReader. Identity: sources/P3DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AutoDetectFormat When this options is enabled, the reader will try to automatically figure out various settings for a binary file. The other options are ignored. Does not work for text (ASCII) files. {"type":"boolean"} native initialisation / omitted false
BinaryFile This property indicates whether the data files are binary. {"type":"boolean"} native initialisation / omitted false
ByteOrder This property specifies the byte order of any binary file(s). {"type":"enum","values":["BigEndian","LittleEndian"]} native initialisation / omitted "BigEndian"
DoublePrecision This property specifies whether floating points values are in double precision. {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the .xyz (geometry) file name for the PLOT3D reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ForceRead This property indicates whether to attempt to read the file even if it appears corrupt {"type":"boolean"} native initialisation / omitted false
FunctionFileName Optional path of the PLOT3D function file (.f) holding extra per-point variables. Leave it out when there is none; the native reader skips an empty function file name. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Functions This property lists which functions (point-centered arrays) to compute. {"items":{"type":"enum","values":["Scalar - Pressure","Scalar - Pressure Coefficient","Scalar - Mach Number","Scalar - Sound Speed","Scalar - Temperature","Scalar - Enthalpy","Scalar - Internal energy","Scalar - Kinetic energy","Scalar - Velocity magnitude","Scalar - Entropy","Scalar - Swirl","Vector - Velocity","Vector - Vorticity","Vector - Pressure gradient","Scalar - Vorticity magnitude","Vector - Strain rate"]},"type":"array"} native initialisation / omitted ["Scalar - Pressure"]
HasByteCount This property indicates whether this file uses Fortran leading-trailing byte counts. {"type":"boolean"} native initialisation / omitted false
IBlanking This property indicates whether this dataset has visibility information. {"type":"boolean"} native initialisation / omitted false
MultiGrid This property indicates whether these files have multiple-block information. {"type":"boolean"} native initialisation / omitted false
PreserveIntermediateFunctions When checked, the reader will preserve intermediate computed quantities that were not explicitly requested e.g. if Velocity magnitude is enabled, but not Velocity, the reader still needs to compute Velocity. If this is unchecked, then the output will not have Velocity array, only the requested VelocityMagnitude. This is useful to avoid using up memory for arrays that are not relevant for the analysis. {"type":"boolean"} native initialisation / omitted false
QFileName The list of .q (solution) files for the PLOT3D reader. There can be more than one. If more that one file is specified, the reader will switch to file-series mode in which it will pretend that it can support time and provide one file per time step. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TwoDimensionalGeometry This property indicates whether the data is two- or three-dimensional. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPLOT3DReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPLYReader#

Full native PLY reader: reads Stanford PLY polygon files (ASCII or binary) into polydata. ParaView's documentation requires vertex elements with x, y and z and face elements with vertex_indices; further vertex properties such as normals, colours or texture coordinates are carried along as arrays. Several file names form a time series. Use readPLY for one file; use this operation for file series or the texture-coordinate settings.

Common mistakes and assumptions:

  • PLY carries no unit; compare the bounds with the simulation's length unit before combining.
  • Point-cloud files without face elements fall outside ParaView's documented requirement; check the output before relying on them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: PLYReader. Identity: sources/PLYReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DuplicatePointsForFaceTexture If true (default) and the "face" element has the property "texcoord" duplicate face points if they have 2 or more different texture coordinates. Otherwise, each texture coordinate for a face point overwrites previously set texture coordinates for that point. {"type":"boolean"} native initialisation / omitted false
FaceTextureTolerance Tolerance used to detect different texture coordinates for shared points for faces {"type":"number"} native initialisation / omitted 1
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPLYReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvPNGSeriesReader#

Reads PNG images (.png) into uniform image data with 8- or 16-bit, 1 to 4 component point scalars. Several files are stacked into a volume by default (ReadAsImageStack true), e.g. a segmentation-mask stack; set it false to read them as a time series. PNG is lossless, so values are exact; pair with pvWritePNGWriter for round trips.

Common mistakes and assumptions:

  • PNG stores no physical pixel size; set DataSpacing to place the image in world units.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PNGSeriesReader. Identity: sources/PNGSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DataSpacing Set the spacing to use for the image output by this reader. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
ReadAsImageStack When set, the reader will read the set of files as an image stack, rather than a temporal file series. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPNGSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvPTSReader#

Reads an ASCII PTS point cloud (.pts: point count, then x y z [intensity [r g b]] per line), as produced by laser scanners, into polydata with one vertex cell holding all points and Intensities and Color arrays when present. Optional limits subsample the file to a maximum number of points and/or keep only points inside a box. Use pvPDALReader for LAS/LAZ point clouds.

Common mistakes and assumptions:

  • Scanner coordinates are often large georeferenced values; float storage can lose precision, so translate the cloud near the origin if fine detail matters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: PTSReader. Identity: sources/PTSReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the PTS (ASCII Point Cloud) reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
LimitNumberOfPointsRead Limits the number of points read in from file {"type":"boolean"} native initialisation / omitted false
LimitPointCloudToBounds Restrict the point to cloud to a specified volume. {"type":"boolean"} native initialisation / omitted false
MaxNumberOfPoints Specify the max number of point to be read. {"type":"integer"} native initialisation / omitted 1
ReadBounds Define the spatial volume that will restrict the extent of the point cloud [xmin, xmax, ymin, ymax, zmin, zmax] {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPTSReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPVDReader#

Reads a ParaView .pvd collection: an XML index listing VTK XML data files (.vtu, .vtp, .vti, .vtm, .vtt …) with timestep, part and group attributes. Distinct timestep values become a time series; several parts at one time are combined into a composite (multiblock) output. Use it to reopen results written by pvWriteXMLPVDWriter or by solvers that emit .pvd; for a single VTK XML file use the matching reader such as pvXMLUnstructuredGridReader.

Common mistakes and assumptions:

  • File names inside the .pvd are normally relative to the .pvd's folder; move the referenced files with it.
  • Array lists apply to every referenced file; name arrays explicitly when later nodes depend on them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PVDReader. Identity: sources/PVDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ColumnArrays This property lists which columns to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the file name for the PVD reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPVDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPVTrivialProducer#

ParaView's trivial producer (vtkPVTrivialProducer) wraps an existing data object and can also report time steps and a whole extent for structured data split across processes. As with pvTrivialProducer, the data must be attached by native code, which Schemaxis input cannot do, so it is not a useful authoring operation.

Common mistakes and assumptions:

  • Schemaxis has no authored way to hand a dataset to a trivial producer, so the node is expected to produce an empty output; this has not been run.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PVTrivialProducer. Identity: sources/PVTrivialProducer. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
WholeExtent The values of this property specify the whole extent of the topologically regular grid. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPVTrivialProducer"
}

pvPVTrivialProducer2#

A second registration of ParaView's vtkPVTrivialProducer without the WholeExtent property, used internally by ParaView. It needs a data object attached from native code, which Schemaxis input cannot provide, so it is not useful in an authored workflow; use pvPVTrivialProducer's documentation for context and a reader for real data.

Common mistakes and assumptions:

  • Schemaxis has no authored way to hand a dataset to a trivial producer, so the node is expected to produce an empty output; this has not been run.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PVTrivialProducer2. Identity: sources/PVTrivialProducer2. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPVTrivialProducer2"
}

pvParallelNetCDFPOPreader#

Reads Parallel Ocean Program (POP) output stored in NetCDF (.pop.ncdf, .pop.nc) into a rectilinear grid, with only some MPI processes reading the file and sending the data to the others. ParaView marks this proxy mpi_required, so it is meant for runs with several ranks; for serial runs use pvNetCDFPOPreader. VariableArrayStatus selects the ocean variables and Stride subsamples the grid.

Common mistakes and assumptions:

  • In an ordinary single-rank Schemaxis run this reader may be unavailable; set ranks above 1 (mpiexec pvbatch) or use pvNetCDFPOPreader.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: ParallelNetCDFPOPreader. Identity: sources/PNetCDFPOPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Stride This property indicates the number of indices per dimension (i,j,k) to skip between each point included in this output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
VariableArrayStatus NetCDF variables to load onto the grid, e.g. potential temperature or salinity (POP names such as TEMP or SALT). Variables not listed are not read, which saves memory and transfer between processes. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvParallelNetCDFPOPreader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvParticlePath#

Advects particles from the seed points (SeedSource port) through a time-varying vector field (Input port) and outputs pathlines: polylines tracing each particle from injection up to the requested time, with arrays such as ParticleId, ParticleAge and InjectionStepId. It integrates through the input's time steps from the first, so later scene times cost more. Use it for unsteady flows where instantaneous streamlines mislead; pvParticleTracer returns only current positions and streamTracer instantaneous streamlines.

Common mistakes and assumptions:

  • A single-step input does not move particles; use streamTracer for steady fields.
  • TerminationTime is hidden in ParaView 5.13.3 and a no-op in the VTK 9.4.1 source; limit the time span with pvExtractTimeSteps instead.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ParticlePath. Identity: filters/ParticlePath. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Compute vorticity and angular rotation of particles as they progress {"type":"boolean"} native initialisation / omitted false
ForceReinjectionEveryNSteps When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds Has no effect on this filter in ParaView 5.13.3: StaticSeeds is only initialised and printed by vtkParticleTracerBase, which the filter derives from, and nothing in it reads the value. Only the legacy tracers read it (pvLegacyParticlePath, pvLegacyStreakLine and pvInSituParticlePath). ParaView's own text says that setting it to 1 avoids repeated grid searches for unchanging seeds; that holds for those operations, not for this one. {"type":"boolean"} native initialisation / omitted false
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
TerminationTime Setting TerminationTime to a positive value will cause particles to terminate when the time is reached. The units of time should be consistent with the primary time variable. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvParticlePath",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvParticleTracer#

Advects particles from the seed points (SeedSource port) through a time-varying vector field (Input port) and outputs, at the requested time, only the current particle positions as points with attributes such as ParticleId and ParticleAge; no paths are kept and no cells are created. ForceReinjectionEveryNSteps releases new particles periodically for a continuous stream. Use it to animate particle clouds in unsteady flow; pvParticlePath keeps trajectories.

Common mistakes and assumptions:

  • The output has points but no cells, so cell-based operations and surface rendering see nothing; glyph the points or render them as points.
  • Each requested time integrates from the first input step, so long transients are slow.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ParticleTracer. Identity: filters/ParticleTracer. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Compute vorticity and angular rotation of particles as they progress. {"type":"boolean"} native initialisation / omitted false
ForceReinjectionEveryNSteps When animating particles, it is nice to inject new ones every Nth step to produce a continuous flow. Setting ForceReinjectionEveryNSteps to a non zero value will cause the particle source to reinject particles every Nth step even if it is otherwise unchanged. Note that if the particle source is also animated, this flag will be redundant as the particles will be reinjected whenever the source changes anyway. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds Has no effect on this filter in ParaView 5.13.3: StaticSeeds is only initialised and printed by vtkParticleTracerBase, which the filter derives from, and nothing in it reads the value. Only the legacy tracers read it (pvLegacyParticlePath, pvLegacyStreakLine and pvInSituParticlePath). ParaView's own text says that setting it to 1 avoids repeated grid searches for unchanging seeds; that holds for those operations, not for this one. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvParticleTracer",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvParticlesReader#

Reads simple particle files (text or binary records of x, y, z and an optional scalar, as float or double) into polydata points with vertex cells and, when HasScalar is true, one scalar point array. Several files form a time series. Use it for raw particle dumps; for structured text tables use pvCSVReader followed by pvTableToPoints.

Common mistakes and assumptions:

  • For binary files ByteOrder and DataType must match how the file was written; a mismatch gives garbage coordinates without an error.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: ParticlesReader. Identity: sources/ParticleReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ByteOrder Set/Get the byte ordering of the file you are trying to read in. {"type":"enum","values":["BigEndian","LittleEndian"]} native initialisation / omitted "BigEndian"
DataType Get/Set the data type. The options are: - Float (10) (default) single precision floating point. - Double (11) double precision floating point. {"type":"enum","values":["Float","Double"]} native initialisation / omitted "Float"
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
FileType Set the file type. The options are: - Unknown (0) (default) the reader will attempt to determine the file type. If this fails then you should set the file type yourself. - Text (1) the file type is text. - Binary (2) the file type is binary. {"type":"enum","values":["Unknown","Text","Binary"]} native initialisation / omitted "Unknown"
HasScalar Default: 1. If 1 then each particle has a value associated with it. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvParticlesReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvPartitionBalancer#

For partitioned data (vtkPartitionedDataSet or collections), makes every MPI process hold the same number of partitions by adding empty (null) partitions, and drops empty input partitions. Squash (ParaView default) pads only up to the largest per-process count; Expand gives every non-empty partition its own global index, so partition n exists on exactly one process. Data and geometry are unchanged. Use it before writers or filters that expect a consistent partition layout; in a serial run it only removes empty partitions.

Common mistakes and assumptions:

  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PartitionBalancer. Identity: filters/PartitionBalancer. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Mode Set the method for balancing partitions {"type":"enum","values":["Expand","Squash"]} native initialisation / omitted "Expand"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPartitionBalancer",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPartitionedDataSetCollectionSource#

Generates a vtkPartitionedDataSetCollection of up to 12 parametric surfaces (Boy, Cross Cap, Figure-8 Klein, Klein, Mobius, Roman, Conic Spiral, Dini, Ellipsoid, Enneper, Super Toroid, Torus, in that order), shifted 2.5 units apart along x, each split into partitions and grouped in a data assembly by orientability. Point arrays "ObjectId" and "PartitionId" identify shape and partition. Use it to test how pipelines handle partitioned collections and assemblies.

Common mistakes and assumptions:

  • The surfaces are mathematical test shapes; several are non-orientable, which affects normals.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: PartitionedDataSetCollectionSource. Identity: sources/PartitionedDataSetCollectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberOfShapes Select number of shapes to generate in the output. Each shape is created as a vtkPartitionedDataSet in the output data. {"maximum":12,"minimum":0,"type":"integer"} native initialisation / omitted 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPartitionedDataSetCollectionSource"
}

pvPartitionedLegacyVTKReader#

Reads a partitioned legacy VTK data set: a .pvtk summary file listing several legacy .vtk piece files (structured points, structured, rectilinear or unstructured grid, or polydata), which are read as one data set. Use it for older parallel outputs; use pvLegacyVTKReader for a single .vtk file and the XML partitioned readers (e.g. pvXMLPartitionedUnstructuredGridReader) for .pvtu or .pvtp data.

Common mistakes and assumptions:

  • The pieces are found through the summary file; keep them with it when moving the data.
  • FileName takes one path, so this reader has no file-series mode.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: PartitionedLegacyVTKReader. Identity: sources/pvtkfile. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the Partitioned Legacy VTK reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPartitionedLegacyVTKReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPassArrays#

Generated binding of ParaView's Pass Arrays: keeps only the selected arrays of each association (point, cell, field, and for graphs and tables vertex, edge and row data) and removes the rest, with geometry unchanged. An association whose list is empty passes none of its arrays. Unlike the curated passArrays, omitted lists are not set by Schemaxis, so ParaView's own initial selection applies; name every list whose arrays matter.

Common mistakes and assumptions:

  • Omitted lists keep ParaView's initial selection, which Schemaxis has not verified; give an explicit list (possibly []) for every association you care about.
  • Row arrays are the columns of a table; use RowDataArrays, not PointDataArrays, for vtkTable input.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PassArrays. Identity: filters/PassArrays. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPassArrays",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPassThrough#

Returns its input unchanged (vtkPassThrough), for any non-composite dataset. It is useful as a named, stable connection point in a workflow, e.g. to give a reader's output a second node id or to separate a branch for publication; it computes nothing.

Common mistakes and assumptions:

  • Composite (multiblock) inputs are not accepted by the native input domain; use it on single datasets.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PassThrough. Identity: filters/PassThrough. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPassThrough",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPedigreeIDSelectionSource#

Creates a pedigree-ID selection: elements whose value in the input's designated pedigree-ID array matches the given IDs, which are integers (PedigreeIDs) or strings (PedigreeStringIDs), each paired with a domain name. Pedigree IDs identify where an element came from (e.g. a source-file element number) and survive filtering. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Use pvGlobalIDSelectionSource for global IDs.

Common mistakes and assumptions:

  • When PedigreeIDs holds any pair, PedigreeStringIDs is ignored; ParaView's default PedigreeIDs is ["id", "0"], so set PedigreeIDs to [] to use string IDs.
  • The input must carry a pedigree-ID attribute array of the chosen association.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PedigreeIDSelectionSource. Identity: sources/PedigreeIDSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PedigreeIDs The list of integer IDs that will be added to the selection produced by the selection source, specified by the pair (domain, id). Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PedigreeStringIDs The list of string IDs that will be added to the selection produced by the selection source, specified by the pair (domain, id). Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPedigreeIDSelectionSource"
}

pvPerlinNoise#

Adds a point array (default name PerlinNoise) of deterministic Perlin noise evaluated at each point's coordinates, varying between -|Amplitude| and |Amplitude|; geometry is unchanged. Use it to generate smooth pseudo-random test fields, perturb geometry together with a warp, or add texture for rendering. The same coordinates and settings always give the same values.

Common mistakes and assumptions:

  • Frequency is per unit length of the dataset coordinates; on a domain spanning thousands of units the default 1 gives very fine noise, so scale it to your geometry.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PerlinNoise. Identity: filters/PerlinNoise. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeGradients The gradient is not implemented for Perlin noise. {"type":"boolean"} native initialisation / omitted false
ImplicitFunction The noise function sampled at every point. Its only type is "Perlin Noise", with options Frequency (per-axis spatial frequency, higher is finer), Phase (per-axis shift; about one unit repeats the pattern) and Amplitude (output range ±|Amplitude|). {"type":"typed proxy","choices":["Perlin Noise"]} native initialisation / omitted {"type":"Perlin Noise"}
ScalarArrayName Sets the name of the output noise array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested ImplicitFunction → Perlin Noise#

Syntax: {"type":"Perlin Noise","options":{...}}. Native identity: implicit_functions/PerlinNoise. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ImplicitFunction.options.Amplitude Scale of the output values: the noise varies between −|Amplitude| and |Amplitude|. A negative value inverts the pattern. {"type":"number"} native initialisation / omitted 1
ImplicitFunction.options.Frequency Per-axis frequency [fx, fy, fz]: point coordinates are multiplied by these factors before the noise is evaluated, so larger values give finer, faster-varying noise and smaller values broader features; unequal values stretch the pattern along some axes. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ImplicitFunction.options.Phase Shift [px, py, pz] of the noise pattern in noise space (VTK evaluates the noise at coordinate × Frequency − 2 × Phase). The pattern repeats roughly every unit of phase, so 0.5 is about a half-cycle shift; use it to decorrelate several noise layers or move the pattern without changing its scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPerlinNoise",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPhastaReader#

Reads results of the PHASTA parallel CFD solver through its .pht meta-file, an XML description of the geometry and field files per time step and partition. The output is a multipiece dataset of unstructured grid pieces with the solver's fields and time steps. Use it only for PHASTA output.

Common mistakes and assumptions:

  • Keep the files referenced by the .pht where it expects them; FileName names only the meta-file.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PhastaReader. Identity: sources/PhastaReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the Phasta reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPhastaReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvPlane#

Creates a flat parallelogram as polydata: Origin is one corner, and the edges run from Origin to Point1 (the plane's x axis) and from Origin to Point2 (its y axis), subdivided into XResolution × YResolution quadrilaterals. Use it as a seed or probe surface, a sampling plane or reference geometry. The curated plane operation offers the same source with Schemaxis defaults.

Common mistakes and assumptions:

  • ParaView's default resolution is 1 × 1, a single quad; raise the resolution before using it as a probe surface.
  • The two edges need not be perpendicular; non-perpendicular edges give a skewed parallelogram.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Plane. Identity: sources/PlaneSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Origin This property specifies the 3D coordinate of the origin (one corner) of the plane. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point1 This property specifies the 3D coordinate a second corner of the parallelogram. The line connecting this point and that specified by the Origin property define one edge of the parallelogram (its X axis). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property specifies the 3D coordinate a third corner of the parallelogram. The line connecting this point and that specified by the Origin property define a second edge of the parallelogram (its Y axis). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
XResolution This property specifies the number of divisions along the X axis of the parallelogram. {"minimum":1,"type":"integer"} native initialisation / omitted 1
YResolution This property specifies the number of divisions along the Y axis of the parallelogram. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlane"
}

pvPlotData#

ParaView's Plot Data: passes any data object through unchanged (vtkPassThrough) while tagging it for display in a line chart (XYChartView), where ParaView plots its arrays against point or row index. In Schemaxis the data result is the unchanged input; the chart is only a ParaView view preference.

Common mistakes and assumptions:

  • It does not sample or reduce the data; use pvPlotOverLine or a table operation to get plot values along a path.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotData. Identity: filters/PlotAttributes. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotDataOverTime#

Builds time histories by updating the input at every time step it reports and collecting one attribute association (FieldAssociation: Points by ParaView default, Cells, Vertices, Edges or table Rows). Output is a multiblock of tables with a time column: by default one table of per-step statistics (minimum, maximum, quartiles and, for numeric arrays, mean and standard deviation) per input block, otherwise one table per tracked point or cell. Use it for convergence or transient monitoring of a region already reduced to what matters (a probe, slice or clipped zone).

Common mistakes and assumptions:

  • Every time step is computed, so the cost is the number of steps times the upstream pipeline cost.
  • With statistics off, every point or cell becomes its own table; on a large mesh reduce it first (e.g. pvProbeLocation).
  • Elements are matched across steps by global ids, else by index; if the mesh changes over time, per-element histories may not follow the same physical location.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotDataOverTime. Identity: filters/PlotDataOverTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FieldAssociation Select the attribute data to pass. {"type":"enum","values":["Points","Cells","Vertices","Edges","Rows"]} native initialisation / omitted "Points"
OnlyReportSelectionStatistics If this property is set to 1, the min, max, inter-quartile ranges, and (for numeric arrays) mean and standard deviation of all the selected points or cells within each time step are reported -- instead of breaking each selected point's or cell's attributes out into separate time history tables. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotDataOverTime",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotGlobalVariablesOverTime#

Extracts global (field-data) quantities over time into a table with one row per time step, e.g. Exodus global variables such as total energy or time-step size. With AutoDetectGlobalTemporalDataArrays (ParaView default true), arrays flagged as Exodus global temporal variables are used if any exist; otherwise every single-tuple field-data array is collected by updating the input at each time step.

Common mistakes and assumptions:

  • Only field data is read; for point or cell arrays use pvPlotDataOverTime.
  • Input without flagged arrays is updated at every time step, which can be slow for large cases.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotGlobalVariablesOverTime. Identity: filters/ExtractFieldDataOverTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AutoDetectGlobalTemporalDataArrays Automatically detect temporal global data arrays instead plot only such arrays. Otherwise all single-tuple field data arrays in the input field data are plotted. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotGlobalVariablesOverTime",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotOnIntersectionCurves#

ParaView's compound filter that extracts the outer surface of the input, cuts it with an implicit function (SliceType, a plane by default) and orders the resulting intersection edges into polylines. The output is a multiblock of polylines carrying the interpolated point data plus an arc_length array, suitable for line plots of a field along the curve, e.g. pressure around an aerofoil section. Use pvPlotOverLine or probeLine to sample along a straight segment through the volume instead.

Common mistakes and assumptions:

  • Only the surface is cut, so the curves show surface values (e.g. wall quantities), not the interior field.
  • Separate intersection loops become separate blocks, and their arc length starts at 0 for each.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotOnIntersectionCurves. Identity: filters/PlotOnIntersectionCurves. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType This property sets the parameters of the slice function. {"type":"typed proxy","choices":["Box","Cylinder","Plane","Sphere"]} native initialisation / omitted {"type":"Box"}

Nested SliceType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: implicit_functions/Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Bounds Reference box [xmin, xmax, ymin, ymax, zmin, zmax] used only when UseReferenceBounds is true; the box is then these bounds scaled by Length, rotated by Rotation and translated by Position, all about the coordinate origin, so Length [1, 1, 1], Rotation [0, 0, 0] and Position [0, 0, 0] reproduce Bounds exactly. Ignored otherwise. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
SliceType.options.Length With UseReferenceBounds false: edge lengths [Lx, Ly, Lz] of the box along its own axes (ParaView applies them as scale factors to a unit cube). With UseReferenceBounds true: dimensionless scale factors applied to the Bounds box about the coordinate origin. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Position With UseReferenceBounds false: world coordinates [x, y, z] of the box’s minimum corner (before rotation); the box extends from Position to Position + Length along its own axes. With UseReferenceBounds true: a translation applied to the transformed Bounds box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Rotation Rotation angles [rx, ry, rz] about the x, y and z axes, applied about the box’s local origin (its minimum corner at Position, not its centre; with UseReferenceBounds true, about the coordinate origin). The angles are combined in VTK’s Z-X-Y convention: the box transform is Translate · RotateZ · RotateX · RotateY · Scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.UseReferenceBounds Chooses how the box is defined. False: the box is a unit cube scaled by Length, rotated about its corner and placed at Position. True: the box starts from Bounds, and Length, Rotation and Position act as scale, rotation and translation relative to it (about the coordinate origin). {"type":"boolean"} native initialisation / omitted false

Nested SliceType → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: implicit_functions/Cylinder. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Axis Direction [ax, ay, az] of the cylinder's axis line through Center; the cylinder is infinitely long in both directions. For ordinary datasets ParaView normalizes the vector, so only its direction matters. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Center Any point [x, y, z] on the cylinder’s axis line. Moving it along Axis changes nothing; moving it sideways moves the cylinder. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Radius Distance from the axis line to the cylinder surface; points closer than this are inside. {"type":"number"} native initialisation / omitted 1

Nested SliceType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
SliceType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested SliceType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 1,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotOnIntersectionCurves",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotOnSortedLines#

Takes polydata made of line segments, for example the lines produced by slicing a surface, and reassembles them into continuous, ordered polylines, adding an arc_length point array measured along each one. The output is a multiblock dataset with one block per continuous segment, suitable for line charts of a field against distance along an intersection curve. Use pvPlotOnIntersectionCurves to slice and sort in one step, or probeLine / pvPlotOverLine to sample along a straight line instead.

Common mistakes and assumptions:

  • Branching curves are split at junctions into separate blocks; plot each block, not the whole output, as one series.
  • Input must be polydata with line cells; slice or extract edges first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotOnSortedLines. Identity: filters/PlotOnSortedLines. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Plot Edges filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotOnSortedLines",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotOverLine#

Samples all point and cell arrays of the input along the straight segment Point1-Point2 and returns a polyline (polydata) with the interpolated values plus arc_length and vtkValidPointMask point arrays, ready for line charts or CSV export. SamplingPattern chooses uniform samples (ParaView default, Resolution 1000) or exact cell-boundary or one-per-cell sampling. Composite inputs give a single non-composite line. Use probeLine for the same filter with Schemaxis defaults, and pvResampleToLine for a coarse uniform resampling.

Common mistakes and assumptions:

  • Omitted, Point1 and Point2 are never the static [0, 0, 0]: in a bounded native probe with a polydata upstream a batch run read (1, 1, 1) and (-1, -1, -1), a line unrelated to the data (composite inputs give other uninitialised-bounds corners, by the source), and when the upstream already had data they were the corners of its bounding box. Always set both.
  • Samples outside the data have vtkValidPointMask 0 and zero values; filter them out before statistics.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotOverLine. Identity: filters/ProbeLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain probe values. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeTolerance Set whether to compute the tolerance or to use a user provided value. {"type":"boolean"} native initialisation / omitted false
PassCellArrays When set the input cell data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. {"type":"boolean"} native initialisation / omitted false
PassPartialArrays When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial arrays are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, and 0 for all other types of arrays i.e int, char etc. {"type":"boolean"} native initialisation / omitted false
PassPointArrays When set the input point data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
Point1 This property controls the coordinates of the first endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property controls the coordinates of the second endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Resolution This property sets the line resolution if sampling pattern is set to "Sample Uniformly". {"type":"integer"} native initialisation / omitted 1
SamplingPattern "Sample At Cell Boundaries" gives the most accurate plots by creating probing points at the cell borders. "Sample At Segment Centers" provides one sample per probed cell located at the middle of the line intersecting the cell. "Sample Uniformally" samples uniformally along the input line. {"type":"enum","values":["Sample At Cell Boundaries","Sample At Segment Centers","Sample Uniformly"]} native initialisation / omitted "Sample At Cell Boundaries"
Tolerance Set the tolerance to use for vtkDataSet::FindCell {"minimum":2.220446049250313e-16,"type":"number"} native initialisation / omitted 2.220446049250313e-16

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotOverLine",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPlotOverLinesFromCustomSource#

Samples the Input dataset along every line or polyline cell of the Source (polydata or an unstructured grid of lines, e.g. extracted feature edges or a polyline source), interpolating point data and taking cell data from the containing cell. Output is a multiblock with one polydata block per source cell, points ordered along the line. SamplingPattern chooses uniform samples (ParaView default, Resolution 1000), samples at cell boundaries (step profiles of cell data) or one sample per crossed cell. Use pvPlotOverLine or probeLine for a single straight line.

Common mistakes and assumptions:

  • Line end points are always sampled, even outside the data; check the validity mask before using values there.
  • In MPI runs the lines are taken from process 0's Source data and broadcast.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotOverLinesFromCustomSource. Identity: filters/ProbeCustomLines. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain probe values. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain the probing lines locations. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData","vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AggregateAsPolyData If false then each result from an input line to probe results in a block in a vtkMultiBlockDataSet. If true then each block is aggregated as a cell in a single dataset and the output type of the filter becomes a vtkPolyData. Should always be false for this filter. {"type":"integer"} native initialisation / omitted 1
ComputeTolerance Set whether to compute the tolerance or to use a user provided value. {"type":"boolean"} native initialisation / omitted false
PassCellArrays When set the input cell data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. {"type":"boolean"} native initialisation / omitted false
PassPartialArrays When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial arrays are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, and 0 for all other types of arrays i.e int, char etc. {"type":"boolean"} native initialisation / omitted false
PassPointArrays When set the input point data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
Resolution This property sets the line resolution if sampling pattern is set to "Sample Uniformly". {"type":"integer"} native initialisation / omitted 1
SamplingPattern "Sample At Cell Boundaries" gives the most accurate plots by creating probing points at the cell borders. "Sample At Segment Centers" provides one sample per probed cell located at the middle of the line intersecting the cell. "Sample Uniformally" samples uniformally along the input line. {"type":"enum","values":["Sample At Cell Boundaries","Sample At Segment Centers","Sample Uniformly"]} native initialisation / omitted "Sample At Cell Boundaries"
Tolerance Set the tolerance to use for vtkDataSet::FindCell {"minimum":2.220446049250313e-16,"type":"number"} native initialisation / omitted 2.220446049250313e-16

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotOverLinesFromCustomSource",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvPlotSelectionOverTime#

Extracts the points or cells chosen by a selection (the Selection input, e.g. from pvIDSelectionSource or pvLocationSelectionSource) at every time step and reports their values over time. Output is a multiblock of tables with a time column: by ParaView default one table of statistics over the selected elements per step, otherwise one history per element. Location selections take values from the cell containing each location.

Common mistakes and assumptions:

  • Every time step is computed; keep the selection small and the upstream pipeline lean.
  • Turn OnlyReportSelectionStatistics off to get each selected point's own history; the default gives statistics across the selection.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PlotSelectionOverTime. Identity: filters/ExtractSelectionOverTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input from which the selection is extracted. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); tables (rows and columns) (vtkTable); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Required data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input that provides the selection object. Accepted data: selections (vtkSelection). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkSelection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
OnlyReportSelectionStatistics If this property is set to 1, the min, max, inter-quartile ranges, and (for numeric arrays) mean and standard deviation of all the selected points or cells within each time step are reported -- instead of breaking each selected point's or cell's attributes out into separate time history tables. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPlotSelectionOverTime",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Selection": "UPSTREAM_Selection"
  }
}

pvPointAndCellIds#

Adds integer arrays with each point's zero-based index (PointIds, point data) and each cell's index (CellIds, cell data) as numbered in this dataset; hyper tree grid input gets cell ids only. The arrays travel with points and cells through later extraction, so they can trace results back to the original elements. generateIds is the curated alternative.

Common mistakes and assumptions:

  • Ids are local: each block of composite data and each MPI process numbers its own piece; use pvGlobalPointAndCellIds for ids unique across blocks and processes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointAndCellIds. Identity: filters/PointAndCellIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Data to Point Data filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellIdsArrayName The name of the cell ids array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
GenerateCellIds Enable generation of cell ids. {"type":"boolean"} native initialisation / omitted false
GeneratePointIds Enable generation of point ids. {"type":"boolean"} native initialisation / omitted false
PointIdsArrayName The name of the point ids array. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointAndCellIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPointDatasetInterpolator#

Interpolates the point arrays of a point cloud (Input: any point set, e.g. particles, scattered measurements or the points of a mesh) onto the points of a second dataset (Source), weighting nearby cloud points with a kernel. The output keeps Source's type, points and cells and adds the interpolated arrays, so a slice, image or mesh can be coloured by cloud data. Kernels range from Voronoi (nearest point, the ParaView default) to smooth Gaussian or Shepard weighting. Use resample when the data live on a mesh with cells, and pvSPHDatasetInterpolator for SPH particles.

Common mistakes and assumptions:

  • Only the Input's points and point arrays are used; its cells and cell data are not interpolated.
  • Points with no cloud points inside the kernel footprint receive NullValue (0 by default, NullPointsStrategy "Null Value" per the XML default), which can look like real zeros; choose Mask Points to flag them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointDatasetInterpolator. Identity: filters/PointDatasetInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source that provides the structure to be interpolated on. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel Specify an interpolation kernel. By default a vtkVoronoiKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation. {"type":"typed proxy","choices":["Ellipsoidal Gaussian Kernel","Gaussian Kernel","Linear Kernel","Probabilistic Voronoi Kernel","Shepard Kernel","Voronoi Kernel"]} native initialisation / omitted {"type":"Ellipsoidal Gaussian Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
NullPointsStrategy How output points that have no source point in their neighbourhood (null points) get a value. Mask Points adds an output array that marks each point valid (1) or null (0) and also sets the NullValue; Null Value (ParaView's default, entry 1) writes the NullValue to null points; Closest Point uses the closest source point. ParaView's own text calls Closest Point the default, but its XML default is 1 (Null Value), as in vtkPointInterpolator. {"type":"enum","values":["Mask Points","Null Value","Closest Point"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → Ellipsoidal Gaussian Kernel#

Syntax: {"type":"Ellipsoidal Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/EllipsoidalGaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Eccentricity Shape of the ellipsoid relative to each point’s normal: 1 is spherical, values below 1 give a needle along the normal, values above 1 a pancake perpendicular to it. In the weight exp(−Sharpness² · (r⊥²/E² + z²)/R²) it divides the distance measured perpendicular to the normal. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Radius Search radius R in dataset units: source points within it form the neighbourhood, and R also normalizes the distances in the Gaussian weight. If no source point lies within R, the operation’s NullPointsStrategy decides the result. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off of the Gaussian: larger values reduce the influence of distant neighbours (less smoothing), smaller values blend more evenly. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Kernel.options.UseNormals When true, each splat is oriented by the source point’s normal: VTK uses the source’s active normals, or else a point array named “Normals”. If neither exists, the kernel behaves as a spherical Gaussian. {"type":"boolean"} native initialisation / omitted false
Kernel.options.UseScalars When true, each neighbour’s weight is multiplied by its scalar value before normalization, so points with larger scalars dominate (useful for confidence values). VTK uses the source’s active scalars, or else a single-component array named “Scalars”. {"type":"boolean"} native initialisation / omitted false

Nested Kernel → Gaussian Kernel#

Syntax: {"type":"Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/GaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius R around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It also sets the width of the Gaussian: weights are exp(−(Sharpness · r / R)²), so a larger R both gathers more points and smooths more. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off rate s of the Gaussian weights exp(−(s · r / R)²): larger values reduce the influence of more distant neighbours (less smoothing), smaller values blend more evenly across the neighbourhood. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0

Nested Kernel → Linear Kernel#

Syntax: {"type":"Linear Kernel","options":{...}}. Native identity: point_interpolation_kernels/LinearKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Every source point inside it receives the same weight, so a larger radius averages over a wider region. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Probabilistic Voronoi Kernel#

Syntax: {"type":"Probabilistic Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/ProbabilisticVoronoiKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Only source points inside it are candidates for the closest point; if none lie inside, the sample is a null point. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Shepard Kernel#

Syntax: {"type":"Shepard Kernel","options":{...}}. Native identity: point_interpolation_kernels/ShepardKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.PowerParameter Exponent p in the weights 1/r^p. Larger p makes the nearest neighbours dominate (approaching nearest-neighbour behaviour); smaller p averages more evenly. p = 2 uses a fast squared-distance path; other values evaluate a power per neighbour and can be markedly slower. {"maximum":100.0,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It only limits which neighbours take part; their weights depend on distance through PowerParameter, not on the radius. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Voronoi Kernel#

Syntax: {"type":"Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/VoronoiKernel. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointDatasetInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvPointDatatoCellData#

Converts point arrays to cell arrays by averaging, for each cell, the values at its points; with CategoricalData the most frequent value among the cell's points wins instead, which suits integer labels. The output is the same dataset type with new cell arrays, and by ParaView default the point arrays are dropped. Use it when a step needs cell data, e.g. per-cell statistics or cell-based thresholds; pointToCell is the curated version, and cellToPoint or pvCellDatatoPointData go the other way.

Common mistakes and assumptions:

  • Averaging smooths sharp gradients and is not a conservative transfer of extensive quantities.
  • With CategoricalData, a cell whose points carry two equally frequent labels gets one of them deterministically, but VTK's code and its own comment disagree on which (the code's std::max_element keeps the larger value); do not rely on tie order and avoid ties by labelling consistently.
  • PassPointData defaults to false here (unlike pointToCell); enable it if later nodes still need the point arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointDatatoCellData. Identity: filters/PointDataToCellData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Point Data to Cell Data filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CategoricalData Control whether the input point data is to be treated as categorical. If the data is categorical, then the resultant cell data will be determined by a majority rules vote, with ties going to the smaller value. {"type":"boolean"} native initialisation / omitted false
PassPointData The value of this property controls whether the input point data will be passed to the output. If set to 1, then the input point data is passed through to the output; otherwise, only generated cell data is placed into the output. {"type":"boolean"} native initialisation / omitted false
PointDataArraytoprocess Add a point array by name to be converted to cell array. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ProcessAllArrays The value of this property controls whether all input point arrays will be processed and converted into cell arrays. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointDatatoCellData",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPointLineInterpolator#

Interpolates point data from a point cloud (Input) onto a high-resolution straight line set in the Source options (Point1, Point2, Resolution; ParaView default 1000 intervals), producing a polyline profile for line plots. Use it for profiles through scattered or particle data; for data on a mesh with cells, probeLine samples by cell interpolation instead.

Common mistakes and assumptions:

  • The line endpoints may be derived by ParaView from the input bounds, but Schemaxis has not verified that; their static default is [0, 0, 0] for both, a degenerate line. Set Point1 and Point2 explicitly in dataset coordinates.
  • Points with no cloud points inside the kernel footprint receive NullValue (0 by default, NullPointsStrategy "Null Value" per the XML default), which can look like real zeros; choose Mask Points to flag them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointLineInterpolator. Identity: filters/PointLineInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel Specify an interpolation kernel. By default a vtkVoronoiKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation. {"type":"typed proxy","choices":["Ellipsoidal Gaussian Kernel","Gaussian Kernel","Linear Kernel","Probabilistic Voronoi Kernel","Shepard Kernel","Voronoi Kernel"]} native initialisation / omitted {"type":"Ellipsoidal Gaussian Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
NullPointsStrategy How output points that have no source point in their neighbourhood (null points) get a value. Mask Points adds an output array that marks each point valid (1) or null (0) and also sets the NullValue; Null Value (ParaView's default, entry 1) writes the NullValue to null points; Closest Point uses the closest source point. ParaView's own text calls Closest Point the default, but its XML default is 1 (Null Value), as in vtkPointInterpolator. {"type":"enum","values":["Mask Points","Null Value","Closest Point"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Line"]} native initialisation / omitted {"type":"Line"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → Ellipsoidal Gaussian Kernel#

Syntax: {"type":"Ellipsoidal Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/EllipsoidalGaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Eccentricity Shape of the ellipsoid relative to each point’s normal: 1 is spherical, values below 1 give a needle along the normal, values above 1 a pancake perpendicular to it. In the weight exp(−Sharpness² · (r⊥²/E² + z²)/R²) it divides the distance measured perpendicular to the normal. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Radius Search radius R in dataset units: source points within it form the neighbourhood, and R also normalizes the distances in the Gaussian weight. If no source point lies within R, the operation’s NullPointsStrategy decides the result. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off of the Gaussian: larger values reduce the influence of distant neighbours (less smoothing), smaller values blend more evenly. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Kernel.options.UseNormals When true, each splat is oriented by the source point’s normal: VTK uses the source’s active normals, or else a point array named “Normals”. If neither exists, the kernel behaves as a spherical Gaussian. {"type":"boolean"} native initialisation / omitted false
Kernel.options.UseScalars When true, each neighbour’s weight is multiplied by its scalar value before normalization, so points with larger scalars dominate (useful for confidence values). VTK uses the source’s active scalars, or else a single-component array named “Scalars”. {"type":"boolean"} native initialisation / omitted false

Nested Kernel → Gaussian Kernel#

Syntax: {"type":"Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/GaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius R around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It also sets the width of the Gaussian: weights are exp(−(Sharpness · r / R)²), so a larger R both gathers more points and smooths more. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off rate s of the Gaussian weights exp(−(s · r / R)²): larger values reduce the influence of more distant neighbours (less smoothing), smaller values blend more evenly across the neighbourhood. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0

Nested Kernel → Linear Kernel#

Syntax: {"type":"Linear Kernel","options":{...}}. Native identity: point_interpolation_kernels/LinearKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Every source point inside it receives the same weight, so a larger radius averages over a wider region. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Probabilistic Voronoi Kernel#

Syntax: {"type":"Probabilistic Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/ProbabilisticVoronoiKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Only source points inside it are candidates for the closest point; if none lie inside, the sample is a null point. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Shepard Kernel#

Syntax: {"type":"Shepard Kernel","options":{...}}. Native identity: point_interpolation_kernels/ShepardKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.PowerParameter Exponent p in the weights 1/r^p. Larger p makes the nearest neighbours dominate (approaching nearest-neighbour behaviour); smaller p averages more evenly. p = 2 uses a fast squared-distance path; other values evaluate a power per neighbour and can be markedly slower. {"maximum":100.0,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It only limits which neighbours take part; their weights depend on distance through PowerParameter, not on the radius. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Voronoi Kernel#

Syntax: {"type":"Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/VoronoiKernel. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Line#

Syntax: {"type":"Line","options":{...}}. Native identity: extended_sources/HighResLineSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.Point1 Start point [x, y, z] of the line, in the input’s coordinates; the first seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Point2 End point [x, y, z] of the line, in the input’s coordinates; the last seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Resolution Number of equal segments of the probe line; the line has Resolution + 1 sample points, each receiving interpolated values. Higher values give a finer profile along the line. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointLineInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPointPlaneInterpolator#

Interpolates point data from a point cloud (Input) onto a bounded plane set in the Source options (a plane through Center with Normal, limited to BoundingBox plus Padding and refined by Resolution or CellSize), producing a planar grid with interpolated arrays, e.g. a heat-map section through particle or scattered data. For meshes with cells, use slice or resample instead.

Common mistakes and assumptions:

  • The plane's bounding box may be derived by ParaView from the input bounds, but Schemaxis has not verified that (static default [0, 1, 0, 1, 0, 1]); set BoundingBox, Center and Normal explicitly.
  • Points with no cloud points inside the kernel footprint receive NullValue (0 by default, NullPointsStrategy "Null Value" per the XML default), which can look like real zeros; choose Mask Points to flag them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointPlaneInterpolator. Identity: filters/PointPlaneInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel Specify an interpolation kernel. By default a vtkVoronoiKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation. {"type":"typed proxy","choices":["Ellipsoidal Gaussian Kernel","Gaussian Kernel","Linear Kernel","Probabilistic Voronoi Kernel","Shepard Kernel","Voronoi Kernel"]} native initialisation / omitted {"type":"Ellipsoidal Gaussian Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
NullPointsStrategy How output points that have no source point in their neighbourhood (null points) get a value. Mask Points adds an output array that marks each point valid (1) or null (0) and also sets the NullValue; Null Value (ParaView's default, entry 1) writes the NullValue to null points; Closest Point uses the closest source point. ParaView's own text calls Closest Point the default, but its XML default is 1 (Null Value), as in vtkPointInterpolator. {"type":"enum","values":["Mask Points","Null Value","Closest Point"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Bounded Plane"]} native initialisation / omitted {"type":"Bounded Plane"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → Ellipsoidal Gaussian Kernel#

Syntax: {"type":"Ellipsoidal Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/EllipsoidalGaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Eccentricity Shape of the ellipsoid relative to each point’s normal: 1 is spherical, values below 1 give a needle along the normal, values above 1 a pancake perpendicular to it. In the weight exp(−Sharpness² · (r⊥²/E² + z²)/R²) it divides the distance measured perpendicular to the normal. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Radius Search radius R in dataset units: source points within it form the neighbourhood, and R also normalizes the distances in the Gaussian weight. If no source point lies within R, the operation’s NullPointsStrategy decides the result. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off of the Gaussian: larger values reduce the influence of distant neighbours (less smoothing), smaller values blend more evenly. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Kernel.options.UseNormals When true, each splat is oriented by the source point’s normal: VTK uses the source’s active normals, or else a point array named “Normals”. If neither exists, the kernel behaves as a spherical Gaussian. {"type":"boolean"} native initialisation / omitted false
Kernel.options.UseScalars When true, each neighbour’s weight is multiplied by its scalar value before normalization, so points with larger scalars dominate (useful for confidence values). VTK uses the source’s active scalars, or else a single-component array named “Scalars”. {"type":"boolean"} native initialisation / omitted false

Nested Kernel → Gaussian Kernel#

Syntax: {"type":"Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/GaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius R around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It also sets the width of the Gaussian: weights are exp(−(Sharpness · r / R)²), so a larger R both gathers more points and smooths more. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off rate s of the Gaussian weights exp(−(s · r / R)²): larger values reduce the influence of more distant neighbours (less smoothing), smaller values blend more evenly across the neighbourhood. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0

Nested Kernel → Linear Kernel#

Syntax: {"type":"Linear Kernel","options":{...}}. Native identity: point_interpolation_kernels/LinearKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Every source point inside it receives the same weight, so a larger radius averages over a wider region. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Probabilistic Voronoi Kernel#

Syntax: {"type":"Probabilistic Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/ProbabilisticVoronoiKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Only source points inside it are candidates for the closest point; if none lie inside, the sample is a null point. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Shepard Kernel#

Syntax: {"type":"Shepard Kernel","options":{...}}. Native identity: point_interpolation_kernels/ShepardKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.PowerParameter Exponent p in the weights 1/r^p. Larger p makes the nearest neighbours dominate (approaching nearest-neighbour behaviour); smaller p averages more evenly. p = 2 uses a fast squared-distance path; other values evaluate a power per neighbour and can be markedly slower. {"maximum":100.0,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It only limits which neighbours take part; their weights depend on distance through PowerParameter, not on the radius. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Voronoi Kernel#

Syntax: {"type":"Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/VoronoiKernel. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Bounded Plane#

Syntax: {"type":"Bounded Plane","options":{...}}. Native identity: extended_sources/BoundedPlaneSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.BoundingBox Axis-aligned region [xmin, xmax, ymin, ymax, zmin, zmax] that limits the plane: the output is the part of the plane inside this box (after Padding). The box is also the domain of the internal sampling grid, so a larger box at the same Resolution gives coarser spacing. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
Source.options.CellSize Edge length of the cubic grid cells when RefinementMode is “Use cell-size”: the box gets ceil(length / CellSize) cells per axis and is re-centred, so it may grow slightly. Smaller values give more samples. Ignored for “Use resolution”. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Source.options.Center A point the sampling plane passes through. With Normal it fixes the plane; keep it inside BoundingBox. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Normal Direction perpendicular to the sampling plane; its length does not matter. [0, 0, 1] gives a plane parallel to the x–y plane. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Padding Distance added on every side of BoundingBox before the plane is generated, so samples can extend slightly beyond the data. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Source.options.RefinementMode “Use resolution” divides the (padded) box into Resolution equal cells along every axis, so the spacing differs per axis when the box is not cubic; “Use cell-size” uses cubic cells of edge CellSize, giving the same spacing in every direction. {"type":"enum","values":["Use resolution","Use cell-size"]} native initialisation / omitted "Use resolution"
Source.options.Resolution Number of grid divisions along each axis of the padded box when RefinementMode is “Use resolution” (the same value on all three axes). The plane’s sample points lie where it crosses this grid, so higher values give denser sampling. Ignored for “Use cell-size”. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointPlaneInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPointSetToOctreeImage#

Bins a point set (point cloud or any vtkPointSet) into a uniform image covering the points' bounding box, sized so that each cell holds about NumberOfPointsPerCell points. The output (a partitioned dataset containing one image) has an unsigned-char cell array "octree" whose eight bits record which octants of each cell contain points, and optionally a float cell array, named after a chosen single-component point array, with per-cell last value, min, max, count, sum and/or mean components. Use it to voxelize particle or LiDAR data, or with pvOctreeImagetoPointSet as a compact, lossy point-cloud encoding.

Common mistakes and assumptions:

  • NumberOfPointsPerCell must not exceed the number of input points, otherwise the filter fails.
  • With ProcessInputPointArray true, the array must have one component and at least one Compute option must be on; ComputeMean also adds Count and Sum components.
  • LastValue is not deterministic under multithreading; prefer Mean, Min or Max for reproducible results.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointSetToOctreeImage. Identity: filters/PointSetToOctreeImage. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeCount Set if the count of the values for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
ComputeLastValue Set if the last value for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
ComputeMax Set if the max value for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
ComputeMean Set if the mean value for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
ComputeMin Set if the min value for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
ComputeSum Set if the sum of the values for each cell id of the point array will be computed. {"type":"boolean"} native initialisation / omitted false
NumberOfPointsPerCell Set the average number of points in each cell of the output image. {"type":"integer"} native initialisation / omitted 1
PointArray The value of this property contains the name of the scalar point array to be processed. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ProcessInputPointArray Set if input point array should be processed. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointSetToOctreeImage",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPointSource#

Creates a cloud of NumberOfPoints points placed pseudo-randomly with uniform density inside a sphere of radius Radius around Center, as polydata vertices. Use it as a seed cloud for streamlines or particle tracing, or as test input. With the ParaView defaults (one point, radius 0) it yields a single point at the centre.

Common mistakes and assumptions:

  • Positions come from VTK's pseudo-random generator; do not rely on identical positions across sessions or ParaView versions.
  • Radius 0 puts every point at the centre; set a radius when you need a spread.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: PointSource. Identity: sources/PointSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center This property specifies the 3D coordinates of the center of the point cloud. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
NumberOfPoints This property specifies the number of points in the point cloud. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Radius This property specifies the radius of the point cloud, measured from the value of the Center property. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointSource"
}

pvPointVolumeInterpolator#

Interpolates point data from a point cloud (Input) onto a bounded volume set in the Source options (Origin, Scale, Padding and Resolution or CellSize), producing image data that can be contoured, sliced or volume-rendered. Use it to turn scattered or particle data into a regular grid; the grid resolution and the kernel radius together set how smooth the result is.

Common mistakes and assumptions:

  • The volume's origin and extent may be derived by ParaView from the input bounds, but Schemaxis has not verified that (static defaults origin [0, 0, 0], scale [1, 1, 1]); set Origin, Scale and Resolution explicitly.
  • Points with no cloud points inside the kernel footprint receive NullValue (0 by default, NullPointsStrategy "Null Value" per the XML default), which can look like real zeros; choose Mask Points to flag them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PointVolumeInterpolator. Identity: filters/PointVolumeInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel Specify an interpolation kernel. By default a vtkVoronoiKernel is used (i.e., closest point). The interpolation kernel changes the basis of the interpolation. {"type":"typed proxy","choices":["Ellipsoidal Gaussian Kernel","Gaussian Kernel","Linear Kernel","Probabilistic Voronoi Kernel","Shepard Kernel","Voronoi Kernel"]} native initialisation / omitted {"type":"Ellipsoidal Gaussian Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
NullPointsStrategy How output points that have no source point in their neighbourhood (null points) get a value. Mask Points adds an output array that marks each point valid (1) or null (0) and also sets the NullValue; Null Value (ParaView's default, entry 1) writes the NullValue to null points; Closest Point uses the closest source point. ParaView's own text calls Closest Point the default, but its XML default is 1 (Null Value), as in vtkPointInterpolator. {"type":"enum","values":["Mask Points","Null Value","Closest Point"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Bounded Volume"]} native initialisation / omitted {"type":"Bounded Volume"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → Ellipsoidal Gaussian Kernel#

Syntax: {"type":"Ellipsoidal Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/EllipsoidalGaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Eccentricity Shape of the ellipsoid relative to each point’s normal: 1 is spherical, values below 1 give a needle along the normal, values above 1 a pancake perpendicular to it. In the weight exp(−Sharpness² · (r⊥²/E² + z²)/R²) it divides the distance measured perpendicular to the normal. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Radius Search radius R in dataset units: source points within it form the neighbourhood, and R also normalizes the distances in the Gaussian weight. If no source point lies within R, the operation’s NullPointsStrategy decides the result. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off of the Gaussian: larger values reduce the influence of distant neighbours (less smoothing), smaller values blend more evenly. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Kernel.options.UseNormals When true, each splat is oriented by the source point’s normal: VTK uses the source’s active normals, or else a point array named “Normals”. If neither exists, the kernel behaves as a spherical Gaussian. {"type":"boolean"} native initialisation / omitted false
Kernel.options.UseScalars When true, each neighbour’s weight is multiplied by its scalar value before normalization, so points with larger scalars dominate (useful for confidence values). VTK uses the source’s active scalars, or else a single-component array named “Scalars”. {"type":"boolean"} native initialisation / omitted false

Nested Kernel → Gaussian Kernel#

Syntax: {"type":"Gaussian Kernel","options":{...}}. Native identity: point_interpolation_kernels/GaussianKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius R around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It also sets the width of the Gaussian: weights are exp(−(Sharpness · r / R)²), so a larger R both gathers more points and smooths more. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06
Kernel.options.Sharpness Fall-off rate s of the Gaussian weights exp(−(s · r / R)²): larger values reduce the influence of more distant neighbours (less smoothing), smaller values blend more evenly across the neighbourhood. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0

Nested Kernel → Linear Kernel#

Syntax: {"type":"Linear Kernel","options":{...}}. Native identity: point_interpolation_kernels/LinearKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Every source point inside it receives the same weight, so a larger radius averages over a wider region. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Probabilistic Voronoi Kernel#

Syntax: {"type":"Probabilistic Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/ProbabilisticVoronoiKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). Only source points inside it are candidates for the closest point; if none lie inside, the sample is a null point. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Shepard Kernel#

Syntax: {"type":"Shepard Kernel","options":{...}}. Native identity: point_interpolation_kernels/ShepardKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.KernelFootprint How the neighbourhood (basis) of source points for each sample point is chosen. “Radius” uses every source point within Radius of the sample (VTK notes it has the better mathematical properties); “N Closest” uses the NumberOfPoints nearest source points regardless of distance, which always finds neighbours in sparse regions but may reach far away. {"type":"enum","values":["Radius","N Closest"]} native initialisation / omitted "Radius"
Kernel.options.NumberOfPoints Number of nearest source points used for each sample when KernelFootprint is “N Closest”; ignored for “Radius”. Larger values blend over more points and smooth more. {"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.PowerParameter Exponent p in the weights 1/r^p. Larger p makes the nearest neighbours dominate (approaching nearest-neighbour behaviour); smaller p averages more evenly. p = 2 uses a fast squared-distance path; other values evaluate a power per neighbour and can be markedly slower. {"maximum":100.0,"minimum":0.001,"type":"number"} native initialisation / omitted 0.001
Kernel.options.Radius Search radius around each sample point, used when KernelFootprint is “Radius” (ignored for “N Closest”). It only limits which neighbours take part; their weights depend on distance through PowerParameter, not on the radius. {"minimum":1e-06,"type":"number"} native initialisation / omitted 1e-06

Nested Kernel → Voronoi Kernel#

Syntax: {"type":"Voronoi Kernel","options":{...}}. Native identity: point_interpolation_kernels/VoronoiKernel. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Bounded Volume#

Syntax: {"type":"Bounded Volume","options":{...}}. Native identity: extended_sources/BoundedVolumeSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.CellSize Edge length of the cubic cells when RefinementMode is “Use cell-size”: the box gets ceil(length / CellSize) cells per axis and is re-centred, so it may grow slightly. Ignored for “Use resolution”. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Source.options.Origin Minimum corner [x, y, z] of the sampling box; the box extends to Origin + Scale along each positive axis. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Padding Distance added on every side of the box before sampling, so the volume can extend beyond the data. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Source.options.RefinementMode “Use resolution” divides the box into Resolution[i] cells along each axis (spacing may differ per axis); “Use cell-size” uses cubic cells of edge CellSize, giving equal spacing in every direction. {"type":"enum","values":["Use resolution","Use cell-size"]} native initialisation / omitted "Use resolution"
Source.options.Resolution Number of cells [nx, ny, nz] along each axis when RefinementMode is “Use resolution”; the volume has (nx + 1)(ny + 1)(nz + 1) sample points. Ignored for “Use cell-size”. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Scale Edge lengths [Lx, Ly, Lz] of the sampling box. Despite the name they are absolute lengths added to Origin, not factors. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPointVolumeInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPolyLineSource#

Creates one polyline through an ordered list of points, optionally closed into a loop. Use it for seed curves, measurement paths, outlines or probe paths that are not straight; for a straight subdivided line use pvLine, for a smooth curve through control points use pvSplineSource.

Common mistakes and assumptions:

  • Points is a flat list of x, y, z triples; a length that is not a multiple of 3 is rejected.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: PolyLineSource. Identity: sources/PolyLineSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Closed When true, a final segment joins the last point back to the first, making a closed loop; when false the polyline is open. {"type":"boolean"} native initialisation / omitted false
Points Coordinates of the polyline vertices as one flat list [x1, y1, z1, x2, y2, z2, …]; the line visits them in this order. Each point needs exactly three numbers. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPolyLineSource"
}

pvPolyPointSource#

Creates polydata containing exactly the points you list, as vertices with no connectivity between them. Use it to place probe or seed locations at known coordinates (e.g. sensor positions) or to mark points in a scene; for random clouds use pvPointSource.

Common mistakes and assumptions:

  • Points is a flat list of x, y, z triples; a length that is not a multiple of 3 is rejected.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: PolyPointSource. Identity: sources/PolyPointSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Points Coordinates of the points as one flat list [x1, y1, z1, x2, y2, z2, …]. Each point needs exactly three numbers; the output keeps the listed order, so point ids follow it. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPolyPointSource"
}

pvPolylineLength#

Adds a point array named arc_length holding, at each point of a polyline, the distance travelled along that polyline from its first point; points of other cell types get 0. The output is the same polydata. Use it after probeLine, a streamline or a contour to plot values against distance along the curve.

Common mistakes and assumptions:

  • VTK assumes cells do not share points; where polylines share a point it can hold only one of the lengths.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PolylineLength. Identity: filters/PolylineLength. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPolylineLength",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvPrincipalComponentAnalysis#

Extends pvMulticorrelativeStatistics with the eigenvalues and eigenvectors of the covariance matrix (optionally normalized, or robust using medians), and assesses data by projecting each observation onto the principal components, using the full basis, a fixed number of components or enough components to reach a fixed energy fraction. Use it to find dominant correlated modes among several fields or to reduce their dimensionality. Output port 0 is the statistical model (a multiblock of tables) and port 1 the input with assessment arrays added; select them with {"node": id, "port": n}.

Common mistakes and assumptions:

  • Without normalization, variables with large variance dominate the components; choose Normalize using covariances when units differ.
  • Task 3 (Model and assess the same data) assesses data that also trained the model, which flatters the fit; prefer a separate data set via ModelInput.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: PrincipalComponentAnalysis. Identity: filters/PCAStatistics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the filter. Arrays from this dataset will be used for computing statistics and/or assessed by a statistical model. Accepted data: image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid); curvilinear structured grids (vtkStructuredGrid); polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); tables (rows and columns) (vtkTable); graphs (vertices and edges) (vtkGraph). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkRectilinearGrid","vtkStructuredGrid","vtkPolyData","vtkUnstructuredGrid","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
ModelInput Optional data input for the native ModelInput port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: A previously-calculated model with which to assess a separate dataset. This input is optional. Accepted data: tables (rows and columns) (vtkTable); multiblock datasets (vtkMultiBlockDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributeMode Attribute association whose arrays are analysed; VariablesofInterest names are looked up in it. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
BasisEnergy The minimum energy to use when determining the dimensionality of the new space into which the assessment will project tuples. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
BasisScheme When reporting assessments, should the full eigenvector decomposition be used to project the original vector into the new space (Full basis), or should a fixed subset of the decomposition be used (Fixed-size basis), or should the projection be clipped to preserve at least some fixed "energy" (Fixed-energy basis)?<p> As an example, suppose the variables of interest were {A,B,C,D,E} and that the eigenvalues of the covariance matrix for these were {5,2,1.5,1,.5}. If the "Full basis" scheme is used, then all 5 components of the eigenvectors will be used to project each {A,B,C,D,E}-tuple in the original data into a new 5-components space.<p> If the "Fixed-size" scheme is used and the "Basis Size" property is set to 4, then only the first 4 eigenvector components will be used to project each {A,B,C,D,E}-tuple into the new space and that space will be of dimension 4, not 5.<p> If the "Fixed-energy basis" scheme is used and the "Basis Energy" property is set to 0.8, then only the first 3 eigenvector components will be used to project each {A,B,C,D,E}-tuple into the new space, which will be of dimension 3. The number 3 is chosen because 3 is the lowest N for which the sum of the first N eigenvalues divided by the sum of all eigenvalues is larger than the specified "Basis Energy" (i.e., (5+2+1.5)/10 = 0.85 > 0.8). {"type":"enum","values":["Full basis","Fixed-size basis","Fixed-energy basis"]} native initialisation / omitted "Full basis"
BasisSize The maximum number of eigenvector components to use when projecting into the new space. {"minimum":1,"type":"integer"} native initialisation / omitted 1
NormalizationScheme Before the eigenvector decomposition of the covariance matrix takes place, you may normalize each (i,j) entry by sqrt( cov(i,i) * cov(j,j) ). This implies that the variance of each variable of interest should be of equal importance. {"type":"enum","values":["No normalization","Normalize using covariances"]} native initialisation / omitted "No normalization"
RobustPCA Compute robust PCA with medians instead of means. {"type":"boolean"} native initialisation / omitted false
Task Specify the task to be performed: modeling and/or assessment. <ol> <li> "Detailed model of input data," creates a set of output tables containing a calculated statistical model of the <b>entire</b> input dataset;</li> <li> "Model a subset of the data," creates an output table (or tables) summarizing a <b>randomly-chosen subset</b> of the input dataset;</li> <li> "Assess the data with a model," adds attributes to the first input dataset using a model provided on the second input port; and</li> <li> "Model and assess the same data," is really just operations 2 and 3 above applied to the same input dataset. The model is first trained using a fraction of the input data and then the entire dataset is assessed using that model.</li> </ol> When the task includes creating a model (i.e., tasks 2, and 4), you may adjust the fraction of the input dataset used for training. You should avoid using a large fraction of the input data for training as you will then not be able to detect overfitting. The <i>Training fraction</i> setting will be ignored for tasks 1 and 3. {"type":"enum","values":["Detailed model of input data","Model a subset of the data","Assess the data with a model","Model and assess the same data"]} native initialisation / omitted "Detailed model of input data"
TrainingFraction Specify the fraction of values from the input dataset to be used for model fitting. The exact set of values is chosen at random from the dataset. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvPrincipalComponentAnalysis",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvProbeLocation#

Samples the input dataset at the points of a probe point cloud (ProbeType; ParaView 5.13.3 offers only the fixed-radius point source) and outputs those points as polydata with interpolated point data, the containing cell's cell data and a vtkValidPointMask array marking points that fell inside the data. Use it for values at a monitor location, and pvPlotDataOverTime after it for a time history. Use probeLine or pvPlotOverLine for profiles.

Common mistakes and assumptions:

  • A probe outside the mesh, or in a region without cells, gets zero values with vtkValidPointMask 0; check the mask.
  • ComputeTolerance (default true) derives the cell-search tolerance from the data; set an explicit Tolerance only if points on cell faces are missed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ProbeLocation. Identity: filters/ProbePoint. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain probe values. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeTolerance Set whether to compute the tolerance or to use a user provided value. On by default. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default. {"type":"boolean"} native initialisation / omitted false
ProbeType This property specifies the dataset whose geometry will be used in determining positions to probe. {"type":"typed proxy","choices":["Fixed Radius Point Source"]} native initialisation / omitted {"type":"Fixed Radius Point Source"}
Tolerance Set the tolerance to use for vtkDataSet::FindCell {"type":"number"} native initialisation / omitted 1

Nested ProbeType → Fixed Radius Point Source#

Syntax: {"type":"Fixed Radius Point Source","options":{...}}. Native identity: extended_sources/FixedRadiusPointSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ProbeType.options.Center Location [x, y, z] to probe, or the centre of the probe sphere when Radius is above 0. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ProbeType.options.NumberOfPoints Number of probe points. With 1 and Radius 0 the data are sampled exactly at Center; larger counts place points at random inside the sphere, giving one output point per probe point. {"minimum":1,"type":"integer"} native initialisation / omitted 1
ProbeType.options.Radius Radius of the sphere in which probe points are placed at random; 0 puts every point at Center. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvProbeLocation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvProcessIdScalars#

Adds an array named ProcessId holding the MPI rank that owns each point (or each cell with CellScalars), so partitioning and load balance can be coloured. In a serial run every value is 0. ParaView deprecated this filter in 5.12 (removal planned for 5.14) in favour of Process Ids; use pvProcessIds in new documents.

Common mistakes and assumptions:

  • Documents using this operation will need migration to pvProcessIds when ParaView 5.14 is absorbed.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ProcessIdScalars. Identity: filters/ProcessIdScalars. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Process Id Scalars filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellScalars The value of this property determines whether to output the array as point data or cell data. {"type":"boolean"} native initialisation / omitted false
RandomMode The value of this property determines whether to use random id values for the various pieces. If set to 1, the unique value per piece will be chosen at random; otherwise the unique value will match the id of the process. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvProcessIdScalars",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvProcessIds#

Adds arrays recording which MPI process owns each point (PointProcessIds) and/or cell (CellProcessIds); hyper tree grids get only cell ids. Geometry is unchanged. Use it to visualize or debug the domain decomposition of a parallel run; in a serial run every value is 0.

Common mistakes and assumptions:

  • Ids reflect the decomposition of the run that executed the pipeline, so they are not reproducible across different process counts.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ProcessIds. Identity: filters/ProcessIds. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateCellData The value of this property determines whether to generate process id for cells. {"type":"boolean"} native initialisation / omitted false
GeneratePointData The value of this property determines whether to generate process id for points. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvProcessIds",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvProtractor#

ParaView's protractor: a polyline (vtkPolyLineSource) through three points, [point 1, vertex, point 2], whose angle at the vertex ParaView's interactive widget displays. In Schemaxis the output is only the polyline geometry; the angle is not written into the data, so compute it from the three points when you need the value. Use it to show an angle annotation in a scene; pvRuler is the equivalent for distances.

Common mistakes and assumptions:

  • ParaView's default Points has only two points, so no angle is defined; give nine numbers.
  • No angle array or measurement is produced by the source itself.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Protractor. Identity: sources/Protractor. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Points Flat list of nine coordinates [x1, y1, z1, xv, yv, zv, x2, y2, z2]: the first arm end point, the vertex where the angle is measured, then the second arm end point. ParaView's angle widget reads the points in exactly this order. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvProtractor"
}

pvQuadricClustering#

Simplifies a polygonal surface by spatial binning: the bounding box is divided into NumberofDimensions bins, all points in a bin collapse to one representative point chosen to minimize quadric error, and degenerate triangles are dropped. It is fast enough for huge meshes (ParaView uses it for level-of-detail rendering), but the result follows the bin grid rather than surface features. Use pvDecimate or decimate when shape fidelity matters more than speed.

Common mistakes and assumptions:

  • Detail smaller than one bin is lost, including thin walls and small holes; increase the divisions on the relevant axis.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: QuadricClustering. Identity: filters/QuadricClustering. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Quadric Clustering filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CopyCellData If this property is set to 1, the cell data from the input will be copied to the output. {"type":"boolean"} native initialisation / omitted false
NumberofDimensions This property specifies the number of bins along the X, Y, and Z axes of the data set. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
UseFeatureEdges If this property is set to 1, feature edge quadrics will be used to maintain the boundary edges along processor divisions. {"type":"boolean"} native initialisation / omitted false
UseFeaturePoints If this property is set to 1, feature point quadrics will be used to maintain the boundary points along processor divisions. {"type":"boolean"} native initialisation / omitted false
UseInputPoints If the value of this property is set to 1, the representative point for each bin is selected from one of the input points that lies in that bin; the input point that produces the least error is chosen. If the value of this property is 0, the location of the representative point is calculated to produce the least error possible for that bin, but the point will most likely not be one of the input points. {"type":"boolean"} native initialisation / omitted false
UseInternalTriangles If this property is set to 1, triangles completely contained in a spatial bin will be included in the computation of the bin's quadrics. When this property is set to 0, the filters operates faster, but the resulting surface may not be as well-behaved. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvQuadricClustering",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRTXMLPolyDataReader#

Real-time VTK XML polydata reader (vtkRTXMLPolyDataReader): it can watch a data directory (Location, optional) for .vtp files arriving from a running simulation; each run of its UpdateToNextFile command reads the next unprocessed file, and ResetReader rescans the directory. FileName names the polydata file read first. Schemaxis declares both commands for onVisit, but a batch run sees only the files present while it runs; use pvXMLPolyDataReader for a fixed file or series.

Common mistakes and assumptions:

  • The order in which arriving files are taken is decided by the native reader and has not been checked by Schemaxis.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: RTXMLPolyDataReader. Identity: sources/RTXMLPolyDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Set the file name for the real-time VTK polygonal dataset reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Location Optional data directory that the reader watches for new .vtp files; ResetReader rescans it. This is a directory, not a file. When it is left out the native reader uses the current directory at its first check for new data. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

onVisit commands:

{
  "ResetReader": {
    "command": "ResetReader",
    "native": "ResetReader"
  },
  "UpdateToNextFile": {
    "command": "UpdateToNextFile",
    "native": "UpdateToNextFile"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRTXMLPolyDataReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

Example command request (pipeline node only): "onVisit":["ResetReader","UpdateToNextFile"]. Commands run in this authored order before the update.

pvRandomAttributes#

Adds random-valued arrays to a dataset, composite dataset or hyper-tree grid: point and/or cell scalars (1 component) and vectors (3 components) of the chosen DataType, each component drawn between the two ComponentRange values. By ParaView default only cell vectors of unsigned char in [0, 255] are generated. Generated arrays become the active attributes. Use it for test data or to colour blocks distinctly (AttributesConstantPerBlock).

Common mistakes and assumptions:

  • Values are pseudo-random and not guaranteed reproducible between runs; do not use them in results that are compared exactly.
  • Integer data types truncate the range; use Float or Double for continuous values.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RandomAttributes. Identity: filters/RandomAttributeGenerator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Random Scalars filter. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AttributesConstantPerBlock Indicate that the generated attributes are constant within a block. This can be used to highlight blocks in a composite dataset. {"type":"boolean"} native initialisation / omitted false
ComponentRange Set the range values (minimum and maximum) for each component. This applies to all data that is generated. {"items":{"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
DataType Specify the type of array to create (all components of this array are of this type). This holds true for all arrays that are created. {"type":"enum","values":["Bit","Char","UnsignedChar","Short","UnsignedShort","Int","UnsignedInt","Long","UnsignedLong","Float","Double","vtkIdType"]} native initialisation / omitted "Bit"
GenerateCellScalars When true, adds a 1-component random cell array (each value drawn between the ComponentRange bounds, of type DataType). The upstream ParaView text says "point scalars"; this property generates cell scalars. {"type":"boolean"} native initialisation / omitted false
GenerateCellVectors When true, adds a 3-component random cell array (each component drawn between the ComponentRange bounds). The upstream ParaView text says "point vectors"; this property generates cell vectors, and it is the one array type ParaView enables by default. {"type":"boolean"} native initialisation / omitted false
GeneratePointScalars Indicate that point scalars are to be generated. {"type":"boolean"} native initialisation / omitted false
GeneratePointVectors Indicate that point vectors are to be generated. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRandomAttributes",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRandomVectors#

Adds a point array BrownianVectors of random 3-D vectors (random direction, length drawn between MinimumSpeed and MaximumSpeed) and makes it the active vectors; existing vectors are not copied as active. Output has the input's type. Use it for test vector fields or to jitter points with a warp.

Common mistakes and assumptions:

  • The random sequence is not seeded by the filter, so values differ between runs.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RandomVectors. Identity: filters/BrownianPoints. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Random Vectors filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MaximumSpeed This property specifies the maximum length of the random point vectors generated. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
MinimumSpeed This property specifies the minimum length of the random point vectors generated. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRandomVectors",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRectilinearDatatoPointSet#

Converts a rectilinear grid (axis-aligned with per-axis coordinate arrays) into an equivalent structured grid with explicit point coordinates; arrays are kept. Use it before operations that need explicit points or reject rectilinear grids.

Common mistakes and assumptions:

  • Output memory grows by three coordinates per point.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RectilinearDatatoPointSet. Identity: filters/RectilinearGridToPointSet. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: rectilinear grids (vtkRectilinearGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRectilinearDatatoPointSet",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRectilinearGridConnectivity#

Extracts material fragments from rectilinear-grid data (single grids or multiblock collections, typically CTH results) using cell-centred volume-fraction arrays and an isovalue. Fragments are built at sub-cell resolution with an extended marching-cubes table, connected across blocks and MPI processes, and returned as a multiblock dataset with one polydata block per material; cell data carry FragmentId and the integrated attributes such as MaterialVolume. Choose it for fragment counting and volume integration on rectilinear CTH data; for AMR input use pvMaterialInterfaceFilter or pvAMRFragmentsFilter.

Common mistakes and assumptions:

  • Select at least one volume-fraction array; none is selected by default, so the filter produces nothing until you name one.
  • All selected volume-fraction arrays must have the same data type; mixing float, double and unsigned-char arrays stops the filter.
  • Schemaxis serial examples do not establish MPI or client-server behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RectilinearGridConnectivity. Identity: filters/RectilinearGridConnectivity. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: rectilinear grids (vtkRectilinearGrid); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkRectilinearGrid","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DoubleVolumeArrays This property specifies the name(s) of the volume fraction array(s) for generating parts. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FloatVolumeArrays This property specifies the name(s) of the volume fraction array(s) for generating parts. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UnsignedCharacterVolumeArrays This property specifies the name(s) of the volume fraction array(s) for generating parts. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VolumeFractionValue The value of this property is the volume fraction value for the surface. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRectilinearGridConnectivity",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRectilinearGridGeometryFilter#

Converts a rectilinear grid (vtkRectilinearGrid: axis-aligned cells with separate coordinate arrays along x, y and z) into polygonal data. VTK can restrict this to an i-j-k extent, but ParaView exposes no extent, so the whole grid is used: a 3-D grid becomes a cloud of vertices (one per grid point), a 2-D grid a surface of quadrilaterals and a 1-D grid a polyline, with point and cell data carried over. Use surface or pvExtractSurface to get the outer surface of a 3-D grid instead.

Common mistakes and assumptions:

  • Only vtkRectilinearGrid input works: the ParaView domain accepts any dataset, but the VTK class requires a rectilinear grid, so other inputs fail natively.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RectilinearGridGeometryFilter. Identity: filters/RectilinearGridGeometryFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Rectilinear Grid Geometry filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRectilinearGridGeometryFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRedistributeDataSet#

Load-balances a dataset across MPI processes: it computes spatial cuts for the requested number of partitions and moves cells accordingly, assigning boundary cells to one region (ParaView default), duplicating them (marked as duplicate ghost cells) or splitting them. Output is an unstructured grid per process, or a vtkPartitionedDataSet with PreservePartitionsInOutput, and global cell ids can be generated. With default settings a serial run has one partition, so the main effect is conversion to an unstructured grid. It is the newer alternative to pvD3.

Common mistakes and assumptions:

  • Image, rectilinear and structured grids become explicit unstructured grids, which can need much more memory; ParaView warns about this.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RedistributeDataSet. Identity: filters/RedistributeDataSet. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BoundaryMode This property determines how cells that lie on processor boundaries are handled. The "Assign to one region" option assigns each boundary cell to exactly one process, which is useful for isosurfacing. Selecting "Assign to all regions" causes the cells on the boundaries to be copied to each process that shares that boundary. The "Split cells" option breaks cells across process boundary lines so that pieces of the cell lie in different processes. This option is useful for volume rendering. {"type":"enum","values":["Assign to one region","Assign to all regions","Split cells"]} native initialisation / omitted "Assign to one region"
EnableDebugging Retains some helper arrays created for generating global cell Ids and ghost cells that are useful for debugging. {"type":"boolean"} native initialisation / omitted false
GenerateGlobalCellIds Generate global Ids for all cells across partitions. {"type":"boolean"} native initialisation / omitted false
LoadBalanceAcrossAllBlocks When checked, for datasets with multiple blocks, the filter will try to load balance across all blocks otherwise each block is separately load balanced. {"type":"boolean"} native initialisation / omitted false
NumberOfPartitions Requested number of spatial partitions. Any negative value, including ParaView's default -1, uses the number of MPI processes (one in a serial run); a positive value is a hint, which ParaView documents as rounded up to a power of two. {"minimum":-1,"type":"integer"} native initialisation / omitted -1
PreservePartitionsInOutput When unchecked, ranks with more than one partition will merge the partitions into a single vtkUnstructuredGrid. When checked, the partitions are preserved and the output is a vtkPartitionedDataSet. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRedistributeDataSet",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvReductionFilter#

Generic parallel reduction (vtkReductionFilter): an optional pre-gather algorithm runs on each MPI process, the results are gathered, and a post-gather algorithm combines them on one or all processes. The helpers are named by VTK class name (PreGatherHelperName, PostGatherHelperName); the helper proxies themselves cannot be set in Schemaxis. In a serial run there is a single piece, so the operation mainly applies the helpers to it. Prefer pvAppendReduce for the common gather-and-append case.

Common mistakes and assumptions:

  • This proxy's ReductionMode labels for values 0 and 1 are swapped relative to VTK's meaning; read the ReductionMode help before choosing.
  • Schemaxis serial examples do not establish MPI behaviour. Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ReductionFilter. Identity: filters/ReductionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Reduction filter. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateProcessIds If true, the filter will generate vtkOriginalProcessIds arrays indicating the process id on which the cell/point was generated. {"type":"boolean"} native initialisation / omitted false
PassThrough If set to a non-negative value, then produce results using only the node Id specified. {"minimum":-1,"type":"integer"} native initialisation / omitted -1
PostGatherHelperName Set the algorithm that takes multiple inputs and produces a single reduced output. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
PreGatherHelperName Set the algorithm that runs on each node in parallel. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ReduceTo Zero-based MPI rank that receives the gathered result in the two to-one-process modes. It is ignored by "Reduce all data to all processors", and in a serial run the only rank is 0. {"type":"integer"} native initialisation / omitted 1
ReductionMode Where the gathered result ends up. In this proxy's XML the first two labels are swapped relative to VTK: "Move all data to one processor" sets native value 0, which vtkReductionFilter defines as REDUCE_ALL_TO_ONE (the target process holds the result while the others keep their own data), and "Reduce all data to one processor" sets value 1, MOVE_ALL_TO_ONE (the other processes end with no data). "Reduce all data to all processors" gives every process the full result, at the highest memory cost. In a serial run all three give the same result. {"type":"enum","values":["Move all data to one processor","Reduce all data to one processor","Reduce all data to all processors"]} native initialisation / omitted "Move all data to one processor"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "PostGatherHelper": "unsupported property class: vtkSMProxyProperty",
    "PreGatherHelper": "unsupported property class: vtkSMProxyProperty"
  },
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvReductionFilter",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvReflect#

Mirrors the input across an axis-aligned plane and outputs an unstructured grid containing, by ParaView default, both the original and the mirrored copy (CopyInput). The plane is either a face of the input bounding box (X Min to Z Max) or x, y or z = Center. Vectors, normals and tensors are flipped; with FlipAllInputArrays (default true) every signed 3-, 6- or 9-component array is treated as a vector or tensor too. Use it to complete a symmetric half-model; the curated reflect uses the same filter with Schemaxis defaults (plane X at 0).

Common mistakes and assumptions:

  • ParaView's default plane is X Min, the minimum-x face of the bounding box, not x = 0; choose X with Center 0 for a symmetry plane at the origin.
  • The two halves are not merged, so points on the mirror plane are duplicated; run cleanGrid if connectivity across the plane matters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Reflect. Identity: filters/ReflectionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Reflect filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center If the value of the Plane property is X, Y, or Z, then the value of this property specifies the center of the reflection plane. {"type":"number"} native initialisation / omitted 1
CopyInput If this property is set to 1, the output will contain the union of the input dataset and its reflection. Otherwise the output will contain only the reflection of the input data. {"type":"boolean"} native initialisation / omitted false
FlipAllInputArrays If off, only Vectors, Normals and Tensors will be flipped. If on, all 3-component data arrays ( considered as 3D vectors), 6-component data arrays (considered as symmetric tensors), 9-component data arrays (considered as tensors ) of signed type will be flipped. All other arrays won't be flipped and will only be copied. {"type":"boolean"} native initialisation / omitted false
Plane The value of this property determines which plane to reflect across. If the value is X, Y, or Z, the value of the Center property determines where the plane is placed along the specified axis. The other six options (X Min, X Max, etc.) place the reflection plane at the specified face of the bounding box of the input dataset. {"type":"enum","values":["X Min","Y Min","Z Min","X Max","Y Max","Z Max","X","Y","Z"]} native initialisation / omitted "X Min"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvReflect",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRemoteSourceProxy#

ParaView's Remote Source Proxy (vtkPVMultiServerDataSource) mirrors, inside the client's built-in session, a dataset that lives on another server in a multi-server ParaView setup. It has no inputs or file and receives its data only through a native DependencyLink to that external proxy, which Schemaxis does not expose (it is listed as a property gap). In a Schemaxis workflow it therefore has nothing to fetch and is not a useful data source; use a reader or a source operation instead.

Common mistakes and assumptions:

  • The DependencyLink binding is an unsupported native property class, so the node cannot be connected to remote data from authored input.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RemoteSourceProxy. Identity: sources/MultiServerProxy. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "DependencyLink": "unsupported property class: vtkSMProperty"
  },
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRemoteSourceProxy"
}

pvRemoveGhostInformation#

Removes ghost cells and the vtkGhostType point and cell arrays from polydata or unstructured grids; for hyper tree grids it removes the ghost array and masks the ghost cells. Use it before writing or measuring data from a parallel pipeline so duplicated boundary layers are not exported or counted twice.

Common mistakes and assumptions:

  • Only polydata, unstructured grid and hyper tree grid inputs are accepted; for structured data use pvExtractSubset to trim ghost layers.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RemoveGhostInformation. Identity: filters/RemoveGhostInformation. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the remove ghost information filter. This filter operates on unstructured grids and polydata since it removes the ghost cells. It also supports HTGs, in which case it simply masks ghost cells. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData); unstructured grids (vtkUnstructuredGrid); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData","vtkUnstructuredGrid","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRemoveGhostInformation",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRenameArrays#

Passes its input through unchanged except for array names. Each list property holds [current name, new name] pairs for one attribute type: points, cells, field data, graph vertices, graph edges or table rows. It accepts any data object, including composites and tables. Use it to give arrays the names a later step expects, e.g. to make datasets agree before pvAppendDatasets, or to replace solver names before export.

Common mistakes and assumptions:

  • Each list is flat: current name, then new name, repeated. Schemaxis rejects a list with an odd number of entries (INVALID_LENGTH) before the node runs.
  • New names must stay unique within an attribute type; renaming onto an existing name creates a clash.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RenameArrays. Identity: filters/RenameArrays. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays This property associates new names to the input cell array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeArrays This property associates new names to the input edge array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldArrays This property associates new names to the input field array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays This property associates new names to the input point array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowArrays This property associates new names to the input row array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexArrays This property associates new names to the input vertex array names Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRenameArrays",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvResampleAMR#

Samples overlapping AMR data (vtkOverlappingAMR) onto a uniform grid covering the box from Min to Max with NumberofSamples points per axis, taking each value from the finest level that covers the sample. The result is a multiblock of uniform-grid partitions (NumberOfPartitions) with the fields on points (TransferToNodes true) or cells. Use it to compare AMR results with regular-grid data or to export a fixed-resolution image; use pvConvertAMRdatasettoMultiblock to keep the native blocks.

Common mistakes and assumptions:

  • Min and Max both start at [0, 0, 0], which describes no region; always set the box.
  • Parts of the box outside the AMR domain are trimmed, so the grid may have fewer points than requested.
  • Input data are assumed cell-centred and rectilinear AMR is not supported.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ResampleAMR. Identity: filters/AMRResampleFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input for this filter. Accepted data: overlapping AMR data (vtkOverlappingAMR). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkOverlappingAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DemandDrivenMode This property specifies whether the resampling filter will operate in demand-driven mode or not. {"type":"boolean"} native initialisation / omitted false
Max Upper corner [x, y, z] of the box to resample, in the dataset's coordinate units. Together with Min it defines the region; parts beyond the AMR domain are trimmed. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Min Lower corner [x, y, z] of the box to resample, in the dataset's coordinate units. Together with Max it defines the region; parts outside the AMR domain are trimmed to the domain bounds. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
NumberOfPartitions Set the number of subdivisions for recursive coordinate bisection. {"type":"integer"} native initialisation / omitted 1
NumberofSamples Sets the number of samples in each dimension {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
TransferToNodes This property specifies whether the solution will be transferred to the nodes of the extracted region or the cells. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResampleAMR",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvResampleToImage#

Samples the input's point and cell arrays onto a new uniform image (vtkImageData) with SamplingDimensions points along x, y and z, spanning the input bounds (UseInputBounds, ParaView default) or custom SamplingBounds. Values are interpolated at the image points by a probe filter, so cell arrays also become point arrays, and points outside the input get 0 in the vtkValidPointMask array. Use it to convert unstructured results to a regular grid for image writers, volume rendering or pvHistogram2D; resample probes onto an existing mesh instead.

Common mistakes and assumptions:

  • Memory grows with the product of the dimensions: the default 100 × 100 × 100 is a million points per array.
  • Sampling is point-wise without averaging, so features smaller than the spacing can be missed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ResampleToImage. Identity: filters/ResampleToImage. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset whose data will be probed. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SamplingBounds Custom probing bounds {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
SamplingDimensions How many linear samples we want along each axis {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
UseInputBounds Use input bounds or custom ones? {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResampleToImage",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvResampleToLine#

Same native filter as pvPlotOverLine (vtkPVProbeLineFilter) with a different starting configuration: uniform sampling with Resolution 40 and the SamplingPattern hidden in ParaView's GUI. It returns a polyline with the input arrays interpolated along Point1-Point2 plus arc_length and vtkValidPointMask. Use it for a light uniform resampling, e.g. a coarse profile to compare between runs; use pvPlotOverLine or probeLine for detailed profiles.

Common mistakes and assumptions:

  • Omitted, Point1 and Point2 are never the static [0, 0, 0]: in a bounded native probe with a polydata upstream a batch run read (1, 1, 1) and (-1, -1, -1), a line unrelated to the data (composite inputs give other uninitialised-bounds corners, by the source), and when the upstream already had data they were the corners of its bounding box. Always set both.
  • Points outside the data are flagged by vtkValidPointMask 0; exclude them before computing statistics.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ResampleToLine. Identity: filters/ResampleToLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies which data set to resample. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeTolerance Set whether to compute the tolerance or to use a user provided value. {"type":"boolean"} native initialisation / omitted false
PassCellArrays When set the input cell data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. {"type":"boolean"} native initialisation / omitted false
PassPartialArrays When dealing with composite datasets, partial arrays are common i.e. data-arrays that are not available in all of the blocks. By default, this filter only passes those point and cell data-arrays that are available in all the blocks i.e. partial arrays are removed. When PassPartialArrays is turned on, this behavior is changed to take a union of all arrays present thus partial arrays are passed as well. However, for composite dataset input, this filter still produces a non-composite output. For all those locations in a block of where a particular data array is missing, this filter uses vtkMath::Nan() for double and float arrays, and 0 for all other types of arrays i.e int, char etc. {"type":"boolean"} native initialisation / omitted false
PassPointArrays When set the input point data arrays are shallow copied to the output. {"type":"boolean"} native initialisation / omitted false
Point1 This property controls the coordinates of the first endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property controls the coordinates of the second endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Resolution This property sets the line resolution. {"type":"integer"} native initialisation / omitted 1
SamplingPattern How sample points are placed on the line. Sample Uniformly spaces Resolution samples evenly, which smooths over cell structure; Sample At Cell Boundaries puts a pair of points at every cell crossing so cell data appear as exact steps (most faithful); Sample At Segment Centers gives one sample per crossed cell, convenient for cell-wise tables. {"type":"enum","values":["Sample At Cell Boundaries","Sample At Segment Centers","Sample Uniformly"]} native initialisation / omitted "Sample At Cell Boundaries"
Tolerance Set the tolerance to use for vtkDataSet::FindCell {"minimum":2.220446049250313e-16,"type":"number"} native initialisation / omitted 2.220446049250313e-16

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResampleToLine",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvResampleWithDataset#

Samples the arrays of SourceDataArrays at the points of DestinationMesh: the output has the destination's geometry and structure, and its point data holds the source's point and cell values interpolated at each destination point plus a vtkValidPointMask array marking points found inside the source. Both inputs may be composite. Use it to transfer a solution onto another mesh, e.g. CFD results onto a structural or measurement mesh; resample is the curated version and pvResampleToImage samples onto a generated image.

Common mistakes and assumptions:

  • Sampled values are always point data, even for cell-centred source fields.
  • Destination points outside the source have vtkValidPointMask 0 and meaningless values; filter on the mask or enable MarkBlankPointsAndCells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ResampleWithDataset. Identity: filters/ResampleWithDataset. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
DestinationMesh Required data input for the native DestinationMesh port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset whose geometry will be used in determining positions to probe. The mesh comes from this dataset. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SourceDataArrays Required data input for the native SourceDataArrays port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain probe values. The data attributes come from this dataset. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CategoricalData Control whether the source point data is to be treated as categorical. If the data is categorical, then the resultant data will be determined by a nearest neighbor interpolation scheme rather than by linear interpolation. {"type":"boolean"} native initialisation / omitted false
CellLocator The cell locator to use for finding cells for probing. {"type":"typed proxy","choices":["BSP Tree Cell Locator","Cell Locator","OBB Tree Cell Locator","Static Cell Locator","Tree Cell Locator"]} native initialisation / omitted {"type":"Cell Locator"}
ComputeTolerance Set whether to compute the tolerance or to use a user provided value. On by default. {"type":"boolean"} native initialisation / omitted false
MarkBlankPointsAndCells When set, points that did not get valid values during resampling, and cells containing such points, are marked as blank. {"type":"boolean"} native initialisation / omitted false
PassCellArrays Keeps the DestinationMesh's own cell arrays in the output. Source cell values are never passed as cells; they are sampled to the destination points. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Set whether to pass the field-data arrays from the Input i.e. the input providing the geometry to the output. On by default. {"type":"boolean"} native initialisation / omitted false
PassPartialArrays Set whether to partial data arrays from the Input i.e. the input providing the geometry to the output. Off by default. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Keeps the DestinationMesh's own point arrays in the output next to the values sampled from SourceDataArrays. When false, the points carry only the sampled arrays and vtkValidPointMask. {"type":"boolean"} native initialisation / omitted false
ReduceOutputMemoryUsage IMPORTANT: this option only concerns Hyper Tree Grids sources (including composite source containing HTGs). If checked, the filter will optimize the space allocated to store the output probed values. This option will lower the memory consumption, especially if the probed source contains a lot of data arrays, at the cost of an increased computation time. {"type":"boolean"} native initialisation / omitted false
SnapToCellWithClosestPoint Set whether to snap to the cell with the closest point, if no cell has been found while FindCell is executed. Note: This is useful only when the source is a vtkPointSet. {"type":"boolean"} native initialisation / omitted false
Tolerance Set the tolerance to use for vtkDataSet::FindCell {"minimum":2.220446049250313e-16,"type":"number"} native initialisation / omitted 2.220446049250313e-16

Nested CellLocator → BSP Tree Cell Locator#

Syntax: {"type":"BSP Tree Cell Locator","options":{...}}. Native identity: cell_locators/ModifiedBSPTree. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested CellLocator → Cell Locator#

Syntax: {"type":"Cell Locator","options":{...}}. Native identity: cell_locators/CellLocator. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested CellLocator → OBB Tree Cell Locator#

Syntax: {"type":"OBB Tree Cell Locator","options":{...}}. Native identity: cell_locators/OBBTree. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested CellLocator → Static Cell Locator#

Syntax: {"type":"Static Cell Locator","options":{...}}. Native identity: cell_locators/StaticCellLocator. Omitted nested options retain native values on subsequent visits.

No authored options.

Nested CellLocator → Tree Cell Locator#

Syntax: {"type":"Tree Cell Locator","options":{...}}. Native identity: cell_locators/CellTreeLocator. Omitted nested options retain native values on subsequent visits.

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResampleWithDataset",
  "inputs": {
    "DestinationMesh": "UPSTREAM_DestinationMesh",
    "SourceDataArrays": "UPSTREAM_SourceDataArrays"
  }
}

pvResourceImageTexture#

Typed texture resource (vtkTexture) that loads its image from a file such as a PNG or JPEG. It produces no dataset: other nodes reference it through texture inputs, currently pvLogo's Texture port, and several consumers may share it. Use it when the picture is a file on disk; use pvResourceTexture when the image comes from a pipeline node.

Common mistakes and assumptions:

  • FileName is required and is read by ParaView's image reader; unsupported image formats fail at update.
  • Exercised by examples/schemaxis/paraview-textures.json (receipt in verification/2026-09-16-catalogue-expansion.json); other settings are unverified.

Native constructor: ImageTexture. Identity: textures/ImageTexture. Role: resource. Output kinds: ["texture"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColorMode When color mode is Default, 8-bits textures is equivalent to Direct Scalars, while equivalent to Map Scalars for 16-bits textures. In the case of Map Scalars, all the values are mapped to a generic color map. {"type":"enum","values":["Default","Map Scalars","Direct Scalars"]} native initialisation / omitted "Default"
FileName Set the name of image file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Mode Set the mode in which image data is read. {"type":"enum","values":["ReadFromFile","ReadFromMemory"]} native initialisation / omitted "ReadFromFile"
RestrictPowerOf2ImageSmaller Rendering-only choice used when an image exceeds the graphics card's maximum texture size and must be resampled to power-of-two dimensions: true rounds each dimension down (smaller, blurrier texture), false rounds up. It never changes the image data that consumers such as pvLogo receive. {"type":"boolean"} native initialisation / omitted false
TrivialProducerKey Set the key used to locate the image data object on the server. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "process-local typed native resource",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResourceImageTexture",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvResourcePVLookupTable#

Typed colour lookup-table resource (vtkPVDiscretizableColorTransferFunction) that maps data values to colours, either as a continuous colour map defined by RGBPoints control points or as categorical colours for annotated values (InterpretValuesAsCategories). It is not a dataset: it is connected to lookup-table inputs such as pvColorByArray, pvOMETIFFChannelCalculator or the PLY and OpenVDB writers, and several consumers can share one table. Scene appearances build their own colour maps from field, range and preset, so use this resource only for those explicit ports.

Common mistakes and assumptions:

  • RGBPoints positions are data values; ParaView's GUI usually rescales a new map to the data range, but here nothing rescales it, so set positions that cover your array's range.
  • Optional ScalarOpacityFunction and TransferFunction2D inputs accept pvResourcePiecewiseFunction and pvResourceTransferFunction2D nodes.
  • Exercised by examples/schemaxis/paraview-resources.json and paraview-writer-resources.json (verification/2026-09-16-catalogue-expansion.json); other settings are unverified.

Native constructor: PVLookupTable. Identity: lookup_tables/PVLookupTable. Role: resource. Output kinds: ["lookup-table"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
ScalarOpacityFunction Optional: the opacity transfer-function resource (a pvResourcePiecewiseFunction node) used by the native ScalarOpacityFunction property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. False one object piecewise-function {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"piecewise_functions"}
TransferFunction2D Optional: the 2D transfer-function resource (a pvResourceTransferFunction2D node) used by the native TransferFunction2D property. Give the id of that resource node in this document. Resources are configuration objects, not data results, so no output port can be selected. ParaView: Proxy property used by the ColorOpacityWidget to store a 2D transfer function (vtkImageData). False one object transfer-function-2d {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"transfer_2d_functions"}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AboveRangeColor Set the color to use when a data value is above the range of the color map. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ActiveAnnotatedValues Specify active annotations. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
AllowDuplicateScalars Whether two RGBPoints control points may share the same data value. True keeps both, which creates a sharp colour jump at that value; false makes a later point replace an earlier one at the same position. {"type":"boolean"} native initialisation / omitted false
Annotations Specify annotations. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
AnnotationsInitialized Set to 1 to indicate that the annotations have been initialized. {"type":"boolean"} native initialisation / omitted false
AutomaticDataHistogramComputation Proxy only property used by the ColorOpacityWidget to know if the data histogram should be automatically computed {"type":"boolean"} native initialisation / omitted false
AutomaticRescaleRangeMode Choose whether and how to automatically rescale the color map range. "Never" means the color map range will never be changed. "Grow and update on 'Apply'" will expand the range to contain the union of the current range and the range of the current data source. "Grow and update every timestep" will expand the range to contain the union of the current range and the range of the current data source when the timestep is changed. "Clamp and update every timestep" will update the color map range to the current source data range. {"type":"enum","values":["Never","Grow and update on 'Apply'","Grow and update every timestep","Update on 'Apply'","Clamp and update every timestep"]} native initialisation / omitted "Never"
BelowRangeColor Set the color to use when a data value is below the range of the color map. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
ColorSpace The color space used for interpolation: RGB, HSV, Lab (CIELAB), or Diverging. In HSV mode, if HSVWrap is on, it will take the shortest path in Hue (going back through 0 if that is the shortest way around the hue circle) whereas if HSVWrap is off it will not go through 0 (in order the match the current functionality of vtkLookupTable). Diverging is a special mode where colors will pass through white when interpolating between two saturated colors. In Lab/CIEDE2000 mode, it will take the shortest path in the Lab color space with respect to the CIE Delta E 2000 color distance measure. In Step mode, the color of an interval is the color of the second point of the interval. {"type":"enum","values":["RGB","HSV","Lab","Diverging","Lab/CIEDE2000","Step"]} native initialisation / omitted "RGB"
DataHistogramNumberOfBins Proxy only property used by the ColorOpacityWidget to know the number of bin to use to compute the data histogram {"type":"integer"} native initialisation / omitted 1
Discretize When set, the color transfer function will comprise of discrete colors with number of discrete colors specified using NumberOfTableValues. {"type":"boolean"} native initialisation / omitted false
EnableOpacityMapping When enabled, the opacity transfer function is used for rendering, if applicable. {"type":"boolean"} native initialisation / omitted false
HSVWrap Only used when ColorSpace is HSV: true lets hue interpolation take the shorter way round the colour wheel, passing through red (hue 0) if that is shorter; false never crosses hue 0, matching vtkLookupTable. {"type":"boolean"} native initialisation / omitted false
IndexedColors Colors used when using IndexedLookup is true. Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
IndexedOpacities Opacities used when using IndexedLookup is true. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
InterpretValuesAsCategories When enabled, the color transfer function switches to indexed-lookup (categorical colors) mode. {"type":"boolean"} native initialisation / omitted false
NanColor Set the color to use when NaN (not-a-number) is encountered. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
NanOpacity Set the opacity to use when NaN (not-a-number) is encountered. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
NumberOfTableValues When Discretize is set, this specifies the number of discrete colors that must be present in the transfer function. {"maximum":1024,"minimum":1,"type":"integer"} native initialisation / omitted 1
RGBPoints Specify the control points that form the color-transfer-function. These are a list of 4-tuples of the form (x, r, g, b) where x is the data value, and r,g,b are three color components in the range [0,1]. Complete tuples of 4 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
RescaleOnVisibilityChange Flag indicating whether the color map data range should be updated when a representation's visibility changes. {"type":"boolean"} native initialisation / omitted false
ScalarRangeInitialized Set to 1 to indicate that the scalar range has been initialized. {"type":"boolean"} native initialisation / omitted false
ShowCategoricalColorsinDataRangeOnly When interpreting values as categories, enabling this option results in the display of only the 'active' categorical colors for values in the data range, i.e., values that exist in the source. You may need to click the 'Rescale to Data Range' button to update the active values that are displayed. {"type":"boolean"} native initialisation / omitted false
ShowDataHistogram Proxy only property used by the ColorOpacityWidget to know if the data histogram should be shown {"type":"boolean"} native initialisation / omitted false
UseAboveRangeColor Use special color to use when a data value is above the range of the color map. {"type":"boolean"} native initialisation / omitted false
UseBelowRangeColor Use special color to use when a data value is below the range of the color map. {"type":"boolean"} native initialisation / omitted false
UseLogScale Maps data values to colours on a base-10 logarithmic scale, so equal ratios (10 to 100, 100 to 1000) get equal colour steps. Useful for quantities spanning several orders of magnitude; the RGBPoints positions stay in data units. {"type":"boolean"} native initialisation / omitted false
UseOpacityControlPointsFreehandDrawing Proxy only property used by the ColorOpacityWidget to know if freehand drawing should be used {"type":"boolean"} native initialisation / omitted false
Using2DTransferFunction Proxy only property used by the ColorOpacityWidget to know if a 2D transfer function is being used. {"type":"boolean"} native initialisation / omitted false
UsingSeparateOpacityArray Proxy only property used by the ColorOpacityWidget to know if a separate array is being used to map opacity in volume rendering. {"type":"boolean"} native initialisation / omitted false
VectorComponent Zero-based component of a multi-component array to colour by when VectorMode is Component (0 = x or first component, 1 = y, 2 = z). Ignored in Magnitude mode and for single-component arrays. {"type":"integer"} native initialisation / omitted 1
VectorMode How a multi-component array (for example velocity) becomes a single value for colouring: Magnitude uses the vector length, Component uses the one component chosen by VectorComponent. Single-component arrays are unaffected. {"type":"enum","values":["Magnitude","Component"]} native initialisation / omitted "Magnitude"

onVisit commands:

{
  "Build": {
    "command": "Build",
    "native": "Build"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "process-local typed native resource",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResourcePVLookupTable"
}

Example command request (pipeline node only): "onVisit":["Build"]. Commands run in this authored order before the update.

pvResourcePiecewiseFunction#

Typed piecewise-function resource (vtkPiecewiseFunction) that maps a data value to a single number, normally opacity from 0 to 1, through control points. Its main use is the ScalarOpacityFunction input of pvResourcePVLookupTable, where it defines how transparent each data value is. It produces no dataset and can be shared by several lookup tables.

Common mistakes and assumptions:

  • Points positions are data values and are not rescaled automatically; place them across your array's range.
  • Exercised by examples/schemaxis/paraview-resources.json (verification/2026-09-16-catalogue-expansion.json); other settings are unverified.

Native constructor: PiecewiseFunction. Identity: piecewise_functions/PiecewiseFunction. Role: resource. Output kinds: ["piecewise-function"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AllowDuplicateScalars Whether two control points may share the same x value. True keeps both, giving a vertical step in opacity at that value; false makes the later point replace the earlier one. {"type":"boolean"} native initialisation / omitted false
Points Control points as a flat list of [x, y, midpoint, sharpness] groups: x is the data value, y the function value there (usually opacity 0 to 1), midpoint (0 to 1) where between this point and the next the value is halfway, and sharpness from 0 (linear) to 1 (step). Give groups in increasing x. Complete tuples of 4 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
ScalarRangeInitialized Set to 1 to indicate that the scalar range has been initialized. {"type":"boolean"} native initialisation / omitted false
UseLogScale When true, the position between two control points is measured on a log10 scale of the data value, so the function changes evenly per decade rather than per unit. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "process-local typed native resource",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResourcePiecewiseFunction"
}

pvResourceTexture#

Typed texture resource (vtkTexture) whose image comes from a connected pipeline node producing image data (vtkImageData), for example a PNG series reader or a resampled field. Like pvResourceImageTexture it is referenced by texture inputs such as pvLogo's Texture port and produces no dataset of its own. Choose it when the texture must follow pipeline changes; use pvResourceImageTexture to load a file directly.

Common mistakes and assumptions:

  • Input must be image data; meshes or tables are rejected by the native input domain.
  • Exercised by examples/schemaxis/paraview-textures.json, where file- and pipeline-backed textures gave identical data (verification/2026-09-16-catalogue-expansion.json resourceChecks); other inputs are unverified.

Native constructor: Texture. Identity: textures/Texture. Role: resource. Output kinds: ["texture"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName A label recording which file the texture originally came from. The native property has no command, so ParaView stores the text without reading anything: the image is always taken from the Input connection. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "process-local typed native resource",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResourceTexture",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvResourceTransferFunction2D#

Typed two-dimensional transfer-function resource (vtkPVTransferFunction2D): colour and opacity defined over two axes, usually a scalar on x and a second quantity such as gradient magnitude on y, as used by ParaView's 2-D volume rendering. It is built from coloured rectangles (Boxes) within Range and sampled to an image of OutputDimensions. In Schemaxis it only connects to the TransferFunction2D input of pvResourcePVLookupTable; Schemaxis scene appearances do not perform volume rendering.

Common mistakes and assumptions:

  • Creating it has no visible effect in Schemaxis images; it is relevant only if a consumer uses the lookup table's 2-D function.
  • Exercised by examples/schemaxis/paraview-resources.json (verification/2026-09-16-catalogue-expansion.json); its rendering effect is unverified.

Native constructor: TransferFunction2D. Identity: transfer_2d_functions/TransferFunction2D. Role: resource. Output kinds: ["transfer-function-2d"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AutomaticRescaleRangeMode Choose whether and how to automatically rescale the color map range. "Never" means the color map range will never be changed. "Grow and update on 'Apply'" will expand the range to contain the union of the current range and the range of the current data source. "Grow and update every timestep" will expand the range to contain the union of the current range and the range of the current data source when the timestep is changed. "Clamp and update every timestep" will update the color map range to the current source data range. {"type":"enum","values":["Never","Grow and update on 'Apply'","Grow and update every timestep","Update on 'Apply'","Clamp and update every timestep"]} native initialisation / omitted "Never"
Boxes Specify the box parameters for the 2D transfer function. These are a list of 8-tuples of the form (x, y, width, height, r, g, b, a) where (x, y) is the position i.e. the range-min of the box, (width, height) specify the dimensions of the box in the scalar units and (r, g, b, a) denote the color with maximum alpha of the box. The color and alpha components are in the range [0, 1]. Complete tuples of 8 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
OutputDimensions The dimensions of the image that represents this 2D transfer function. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
Range The range of the X and Y axes of the transfer function. This is specified as a 4-tuple of the form (xmin, xmax, ymin, ymax). {"items":{"type":"number"},"maxItems":4,"minItems":4,"type":"array"} native initialisation / omitted [1,1,1,1]
ScalarRangeInitialized Set to 1 to indicate that the scalar range has been initialized. {"type":"boolean"} native initialisation / omitted false

onVisit commands:

{
  "Build": {
    "command": "Build",
    "native": "Build"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "process-local typed native resource",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvResourceTransferFunction2D"
}

Example command request (pipeline node only): "onVisit":["Build"]. Commands run in this authored order before the update.

pvRestartedSimExodusReader#

Reads an Exodus simulation that was restarted, through a metadata file listing the output file sets of each restart, so they behave as one continuous time series. The output and the block, set, map and variable selections are those of pvExodusIIReader: a multiblock of unstructured grids with nodal and element variables, displacements applied by default. Use pvExodusIIReader for a single run's files.

Common mistakes and assumptions:

  • FileName must name the restart metadata file, not one of the Exodus files.
  • FilePattern, FilePrefix and XMLFileName are optional, as their ParaView file lists are marked optional. Leave them out to read FileName as given: FilePattern and FilePrefix rebuild the file name from a printf-style pattern, so supplying them changes which file is read, and XMLFileName names an optional part and material description.
  • VTK's Exodus reader starts with every result variable disabled; list the PointVariables and ElementVariables you need, or the blocks arrive without fields.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RestartedSimExodusReader. Identity: sources/ExodusRestartReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AnimateVibrations If this flag is on and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid. If this flag is off and HasModeShapes is on, this reader ignores time. This flag has no effect if HasModeShapes is off. {"type":"boolean"} native initialisation / omitted false
ApplyDisplacements Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter. {"type":"boolean"} native initialisation / omitted false
DisplacementMagnitude When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling. {"type":"number"} native initialisation / omitted 1
EdgeBlocks Use this property to select which blocks of edges should be loaded. All edges in the same block will have the same interpolant (linear, quadratic, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeMapArrayStatus Specify which maps defined over edges in the mesh should be loaded. An edge map is a renumbering of all the edges (across all the edge blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetArrayStatus An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge. The accompanying EdgeSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetResultArrayStatus An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the EdgeSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeVariables Use this property to select which variables defined over edges should be loaded. Edges are oriented boundaries of one or more higher-dimensional cells also present in the mesh. Edge variables specify a single value per entry in some edge block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlocks Use this property to select which blocks of elements (cells) should be loaded. All elements (cells) in the same block will have the same interpolant (tetrahedral, triangular, trilinear hexahedral, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementMapArrayStatus Specify which maps defined over elements (cells) in the mesh should be loaded. An element map is a renumbering of all the elements (across all the element blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. These are sometimes called new-style maps because they are specified differently than in older Exodus files, which only allowed a single element map. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetArrayStatus An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element. The accompanying ElementSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetResultArrayStatus An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right. Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the ElementSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementVariables Use this property to select which variables defined over elements (cells) should be loaded. Element variables specify a single value per entry in some element block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlocks Use this property to select which blocks of faces should be loaded. All faces in the same block will have the same interpolant (triangular, bilinear quadrilateral, etc.) and have the same variables defined over them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceMapArrayStatus Specify which maps defined over faces in the mesh should be loaded. A face map is a renumbering of all the faces (across all the face blocks of a file) from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetArrayStatus An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face. The accompanying FaceSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetResultArrayStatus An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the FaceSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceVariables Use this property to select which variables defined over faces should be loaded. Faces are oriented boundaries of one or more higher-dimensional cells also present in the mesh. Face variables specify a single value per entry in some face block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This points to a special metadata file that lists the output files for each restart. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
FilePattern This property contains a text string specifying the pattern used to load files. There are two parts to it: the prefix (%s) and the file number (%i). The format used is the same as that used for printf. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FilePrefix This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property). {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileRange This property controls the indices of the first and last files to be read. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
GenerateFileIdArray Should each cell in the mesh be assigned an integer identifying the file it came from? If turned on, a cell variable named "FileId" should be present. {"type":"boolean"} native initialisation / omitted false
GenerateGlobalElementIdArray Should the reader retrieve the first new-style element map, or if that is not present, the solitary old-style element map (which always exists but may be procedurally generated if it is not stored with the file)? {"type":"boolean"} native initialisation / omitted false
GenerateGlobalNodeIdArray Should the reader retrieve the first new-style node map, or if that is not present, the solitary old-style node map (which always exists but may be procedurally generated if it is not stored with the file)? {"type":"boolean"} native initialisation / omitted false
GenerateObjectIdCellArray Specifies whether a variable named "ObjectId" should be created for each entry of each block and set being loaded and assigned the identifying number of the block or set, so that given a cell one can readily identify the block or set it came from. This is useful for coloring a mesh by block ID or set ID. {"type":"boolean"} native initialisation / omitted false
GlobalVariables Use this property to select which global (i.e., per-mesh) variables should be loaded. Global variables are stored as arrays in the field data of the reader's output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HasModeShapes Some simulations overload the Exodus time steps to represent mode shapes. In this case, it does not make sense to iterate over the "time steps", because they are not meant to be played in order. Rather, each represents the vibration at a different "mode." Setting the value of this property to 1 changes the semantics of the reader to not report the time steps to downstream filters. {"type":"boolean"} native initialisation / omitted false
ModeShape Specify which mode shape to animate when HasModeShapes is on. {"type":"integer"} native initialisation / omitted 1
NodeMapArrayStatus Specify which maps defined over nodes (points) in the mesh should be loaded. A node map is a renumbering of all the points in a file from their offset in the file to some arbitrary integers, usually specifying a unique global ID across a set of files. These are sometimes called new-style maps because they are specified differently than in older Exodus files, which only allowed a single node map. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetArrayStatus An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node. This property specifies which of those sets should be loaded. The accompanying NodeSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetResultArrayStatus An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the NodeSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointVariables Use this property to select which nodal (i.e., per-point) variables should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSetArrayStatus An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right. This property specifies which of those sets should be loaded. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side. For example, a hexahedron has 18 sides: 6 faces and 12 edges. Any of these sides may be individually called out in a set and assigned a result value. The accompanying SideSetResultArrayStatus property specifies which variables defined over those sets should be loaded. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSetResultArrayStatus An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right. Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side. For example, a hexahedron has 18 sides: 6 faces and 12 edges. Any of these sides may be individually called out in a set and assigned a result value. This property specifies which of those variables should be loaded. The corresponding set must also be loaded using the SideSetArrayStatus property in order for the variable to appear. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseLegacyBlockNamesWithElementTypes In previous versions, the reader added the type of elements in the block to the block name when no name was provided for the block. This has issues with consistency when naming blocks across ranks for partitioned files. Hence we no longer do that. For legacy pipelines, one can enable the old behavior by setting this flag to true. {"type":"boolean"} native initialisation / omitted false
UseMetaFile This hidden property must always be set to 1 for this proxy to work. {"type":"boolean"} native initialisation / omitted false
XMLFileName This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks. {"minLength":1,"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRestartedSimExodusReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvRestartedSimSpyPlotReader#

Reads a CTH (Spy Plot) simulation that was restarted, through a metadata file (.spcth-timeseries) listing the output file sets of each restart, so the sets behave as one continuous time series. Output port 0 is the volume data (hierarchical blocks with cell-centred arrays such as material volume fractions), port 1 the tracers and port 2 the markers; select a port with {"node": id, "port": n}. Use pvSpyPlotReader for a single .spcth case and pvspcthhistoryreader for history files.

Common mistakes and assumptions:

  • FileName must name the restart metadata file, not one of the individual .spcth case files.
  • Fields are cell-centred; convert with cellToPoint before operations that need point data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RestartedSimSpyPlotReader. Identity: sources/SPCTHRestartReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to load from the Spy Plot files (for example material volume fractions, masses, pressure or velocity components). Arrays not listed are absent from the output; listing fewer reduces memory and read time. The available names come from the files themselves. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
DistributeFiles In parallel mode, if this property is set to 1, the reader will distribute files or blocks. {"type":"boolean"} native initialisation / omitted false
DownConvertVolumeFraction If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char. {"type":"boolean"} native initialisation / omitted false
FileName This points to a special metadata file that lists the output files for each restart. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
GenerateActiveBlockArray If this property is set to 1, a cell array will be generated that stores the active status of a block. {"type":"boolean"} native initialisation / omitted false
GenerateBlockIdArray If this property is set to 1, a cell array will be generated that stores a unique blockId for each block. {"type":"boolean"} native initialisation / omitted false
GenerateLevelArray If this property is set to 1, a cell array will be generated that stores the level of each block. {"type":"boolean"} native initialisation / omitted false
GenerateMarkers If this property is set to 1, a second output will be created using the markers data stored in the file. {"type":"boolean"} native initialisation / omitted false
GenerateTracers If this property is set to 1, a cell array will be generated that stores the coordinates of any tracers. {"type":"boolean"} native initialisation / omitted false
UseMetaFile This hidden property must always be set to 1 for this proxy to work. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 3,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRestartedSimSpyPlotReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvReverseSense#

Flips the orientation of polygonal data: ReverseCells (ParaView default true) reverses each cell's point order, which flips its implied front face, and ReverseNormals (default false) multiplies existing point and cell normals by −1. Use it when a surface's normals point inward, e.g. an STL with clockwise winding, before shading, normal-based glyphs or operations that assume outward orientation; normals with consistency orients a surface automatically.

Common mistakes and assumptions:

  • Reversing cells while an existing Normals array is left unchanged makes them disagree; enable ReverseNormals too when normals are present.
  • ReverseNormals has no effect if the input carries no normals.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ReverseSense. Identity: filters/ReverseSense. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the ReverseSense filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ReverseCells Flag controls whether to reverse cell ordering. {"type":"boolean"} native initialisation / omitted false
ReverseNormals Flag controls whether to reverse normal orientation. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvReverseSense",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRibbon#

Turns lines and polylines (polydata, e.g. streamlines) into flat ribbon strips that follow each line. The ribbon's orientation comes from a normal: the 3-component point array chosen in Vectors, or the fixed DefaultNormal when UseDefaultNormal is true; with neither, VTK computes sliding normals for each line. Width is the half-width; VaryWidth scales it along the line by the Scalars array from Width at the array minimum to twice Width at its maximum, and Angle rotates the ribbon about the line. Use tube or pvTube for round tubes.

Common mistakes and assumptions:

  • The Vectors array sets the ribbon normal, not the flow direction; selecting the velocity itself, which is tangent to a streamline, gives degenerate ribbons.
  • Lines with duplicate consecutive points, or normals parallel to the line, are skipped; run clean first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Ribbon. Identity: filters/RibbonFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Ribbon filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Angle The value of this property specifies the offset angle (in degrees) of the ribbon from the line normal. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
DefaultNormal Fixed ribbon normal [nx, ny, nz] applied at every point when UseDefaultNormal is true. It is not used when UseDefaultNormal is false, even if the input has no vector array: VTK then computes sliding normals for each line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Scalars The value of this property indicates the name of the input scalar array used by this filter. The width of the ribbons will be varied based on the values in the specified array if the value of the Width property is 1. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
UseDefaultNormal When true, every ribbon is oriented by DefaultNormal regardless of the Vectors array. When false, the selected Vectors array orients the ribbons; if there is none, VTK computes sliding normals along each line. {"type":"boolean"} native initialisation / omitted false
VaryWidth If this property is set to 1, the ribbon width will be scaled according to the scalar array specified in the SelectInputScalars property. Toggle the variation of ribbon width with scalar value. {"type":"boolean"} native initialisation / omitted false
Vectors The value of this property indicates the name of the input vector array used by this filter. If the UseDefaultNormal property is set to 0, the normal vectors for the ribbons come from the specified vector array. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
Width If the VaryWidth property is set to 1, the value of this property is the minimum ribbon width. If the VaryWidth property is set to 0, the value of this property is half the width of the ribbon. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRibbon",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRotationalExtrusion#

Sweeps polygonal data around an axis through the coordinate origin (RotationAxis, ParaView default z) to build a swept surface: free edges and lines become surfaces and vertices become lines, so a profile curve becomes an axisymmetric shell (cylinder, bottle), and Translation or DeltaRadius turn it into a spring or spiral. Capping closes the ends with copies of a filled 2-D input. Output is polydata, a surface rather than a volume; use pvVolumeOfRevolution to sweep 2-D cells into volume cells.

Common mistakes and assumptions:

  • The axis passes through (0, 0, 0); translate the profile first (transform) if the physical axis is elsewhere.
  • Closed surfaces such as a sphere have no free edges, so they give no swept surface, only caps.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: RotationalExtrusion. Identity: filters/RotationalExtrusionFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Rotational Extrusion filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Angle This property specifies the angle of rotation in degrees. The surface is swept from 0 to the value of this property. {"type":"number"} native initialisation / omitted 1
Capping If this property is set to 1, the open ends of the swept surface will be capped with a copy of the input dataset. This works property if the input is a 2D surface composed of filled polygons. If the input dataset is a closed solid (e.g., a sphere), then either two copies of the dataset will be drawn or no surface will be drawn. No surface is drawn if either this property is set to 0 or if the two surfaces would occupy exactly the same 3D space (i.e., the Angle property's value is a multiple of 360, and the values of the Translation and DeltaRadius properties are 0). {"type":"boolean"} native initialisation / omitted false
DeltaRadius The value of this property specifies the change in radius during the sweep process. {"type":"number"} native initialisation / omitted 1
Resolution The value of this property controls the number of intermediate node points used in performing the sweep (rotating from 0 degrees to the value specified by the Angle property. {"minimum":1,"type":"integer"} native initialisation / omitted 1
RotationAxis The values of this property set the direction of the axis around which the rotation is done. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Translation The value of this property specifies the total amount of translation along the rotation axis during the sweep process. Specifying a non-zero value for this property allows you to create a corkscrew (value of DeltaRadius > 0) or spring effect. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRotationalExtrusion",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvRuler#

ParaView's ruler: a straight line (vtkLineSource) from Point1 to Point2 that ParaView's ruler representation labels with its length. In Schemaxis the output is only the line geometry; the distance is not stored in the data, so compute it from the two points when you need the value. Use it as a distance annotation; pvLine gives a subdivided line for probing.

Common mistakes and assumptions:

  • No distance array or measurement is produced by the source itself.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Ruler. Identity: sources/Ruler. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Point1 This property controls the coordinates of the first endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property controls the coordinates of the second endpoint of the line. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvRuler"
}

pvSAVGReader#

Reads a NIST SAVG file (.savg), a plain-text format of coloured points, lines and polygons used for immersive-visualization scenes. The output is a partitioned dataset collection with one polydata partition per primitive kind found (points, lines, polygons), with optional "rgba_colors" and "vertex_normals" point arrays. Use it to bring such scene geometry into a pipeline; it carries no simulation fields.

Common mistakes and assumptions:

  • The file name must end in .savg; the reader ignores any other name and produces nothing.
  • Primitives such as tri, pixel, text and program lines are skipped as unsupported.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SAVGReader. Identity: sources/SAVGReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Specify the file name. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 1,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSAVGReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvSEPReader#

Reads Stanford Exploration Project seismic data: a text .H header describing up to 32 named axes (labels such as CDP, LINE, OFFSET, DEPTH) with their sizes, origins and sampling, which points to the raw .H@ data file. You choose which named axes become the output x, y and z (or x and y for 2-D output) and hold the remaining axes at one index each; the result is uniform image data with an ImageScalars array.

Common mistakes and assumptions:

  • Axis names must match the header labels; when the header has no labels, VTK assigns the default names to the first axes in order.
  • Choose different axes for x, y, z and the fixed dimensions; reusing one axis collapses that direction.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SEPReader. Identity: sources/SEPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ExtentSplitMode This property specifies the extent mode. {"type":"enum","values":["XSlab","YSlab","ZSlab","Block"]} native initialisation / omitted "XSlab"
FileName This property specifies the file name for the SEP reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
FixedDimension1 Name of an extra SEP axis that is not mapped to x, y or z; the output is the single slice at FixedDimension1Value along it (for example one offset of a prestack volume). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FixedDimension1Value Zero-based index along FixedDimension1 of the slice to read, e.g. which offset gather. {"type":"integer"} native initialisation / omitted 1
FixedDimension2 Name of a second fixed SEP axis, used only with 2-D output (OutputGridDimension 2D): the axis that would otherwise be z is held at FixedDimension2Value. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FixedDimension2Value Zero-based index along FixedDimension2 of the slice to read in 2-D output; ignored for 3-D output. {"type":"integer"} native initialisation / omitted 1
OutputGridDimension This property specifies the dimension of the output data set. {"type":"enum","values":["2D","3D"]} native initialisation / omitted "2D"
XDimension Name of the SEP axis mapped to the output x direction; that axis's origin and sampling in the header become the image's x origin and spacing. It must be one of the axis labels in the .H header. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
YDimension Name of the SEP axis mapped to the output y direction, supplying the image's y origin and spacing. It must be one of the axis labels in the .H header. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ZDimension Name of the SEP axis mapped to the output z direction. Only used when OutputGridDimension is 3D; in 2-D output this axis is not used and FixedDimension2 is held fixed instead. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSEPReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvSLACDataReader#

Reads the NetCDF-based mesh and mode files of SLAC's accelerator electromagnetics codes (Omega3P, Tau3P and related tools). MeshFileName is the element mesh; ModeFileName is one mode file (usually an eigenmode with electric and magnetic fields) or several files forming a time series. Output port 0 (External Surface) is the boundary surface and port 1 (Entire Volume) the volume mesh, filled only when ReadInternalVolume is enabled. When a mode file stores a frequency (100 or more, treated as hertz) the complex fields are animated over one period of the lowest frequency: each mode contributes magnitude × FrequencyScale × cos(initial phase + 2πft + PhaseShift) and the modes are summed.

Common mistakes and assumptions:

  • Port 0 is only the external surface; enable ReadInternalVolume and connect {"node": id, "port": 1} for fields inside the cavity.
  • ModeFileName is optional: omit it to read the mesh alone. A bounded native probe on 2026-10-12 (ParaView 5.13.3, serial, synthetic one-tetrahedron mesh) read the mesh with ModeFileName omitted, with no error (4 points, 4 cells); it has not been run on real SLAC files.
  • Mode files must use the same points as the mesh file.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: SLACDataReader. Identity: sources/SLACReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FrequencyScale Sets the scale factor for each mode. By default, each scale factor is set to 1. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
MeshFileName The name of the mesh file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ModeFileName The name of the mode files to load. The points in the mode file should be the same as the mesh file. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PhaseShift Sets the phase offset for each mode. By default, shift is set to 0. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
ReadExternalSurface If on, read the external surfaces of the data set. {"type":"boolean"} native initialisation / omitted false
ReadInternalVolume If on, read the internal volume of the data set. {"type":"boolean"} native initialisation / omitted false
ReadMidpoints If on, reads midpoint information for external surfaces and builds quadratic surface triangles. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSLACDataReader",
  "options": {
    "MeshFileName": "REPLACE_WITH_VALUE"
  }
}

pvSLACParticleDataReader#

Reads particle data written by SLAC's accelerator codes (NetCDF files with the SLAC particle conventions) into polydata: a set of particle points in 3-D space. Several files form a time series, one file per step in the order listed. Use it with pvSLACDataReader to show particles inside the cavity fields.

Common mistakes and assumptions:

  • The native reader loads everything in piece 0; it does not distribute particles across MPI processes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: SLACParticleDataReader. Identity: sources/SLACParticleReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName A list of files to be read in a time series. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSLACParticleDataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvSPHDatasetInterpolator#

Interpolates particle data with smoothed-particle-hydrodynamics kernels: the Input is the particle set (a point set with point arrays, normally including density and optionally mass) and the Source is any dataset whose points receive the SPH-weighted values. The output keeps Source's structure and adds the interpolated arrays, a Shepard-sum array (on by default) and any derivative arrays. Use it to post-process SPH simulation output on meshes, slices or images; for non-SPH scattered data use pvPointDatasetInterpolator.

Common mistakes and assumptions:

  • The kernel SpatialStep (smoothing length h) defaults to 0.0001; set it to the simulation's smoothing length in dataset units, or neighbourhoods are tiny and most output points become null points.
  • DensityArray defaults to the name Rho; name your particle density array if it differs.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SPHDatasetInterpolator. Identity: filters/SPHDatasetInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Source Required data input for the native Source port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source that provides the structure to be interpolated on. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeShepardSum Indicate whether to compute the summation of Shepard coefficients. In the interior of a SPH point cloud, the Shephard summation value should be ~1.0. Towards the boundary, the Shepard summation is less than 1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. {"type":"boolean"} native initialisation / omitted false
CutoffArray Specify the Cutoff array name. If not specified, then the radius at each point will be computed as cutoff factor * smoothing length at a each point. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
DensityArray Specify the density array name. This is required in computation. If not specified the code will error out. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
DerivativeArrays Specify the arrays whose derivative is to be taken. If the name of the array is "derivArray" this will produce an output array with the name "derivArray_deriv" (after filter execution). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ExcludedArrays Specify arrays which are to be excluded from the interpolation process. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Kernel Smoothing kernel W(r, h) used to weight neighbouring particles, following D.J. Price's SPH formulations. All four take the kernel options SpatialStep (the smoothing length h, in dataset units) and Dimension (1 to 3, the dimension of the particle problem, which sets the normalization). They differ in order and support radius: SPH Cubic Kernel (cutoff 2h, cheapest and least smooth), SPH Quartic Kernel (2.5h), SPH Quintic Kernel (3h, higher order, the ParaView default) and SPH Wendland Quintic Kernel (2h, a compactly supported Wendland function). Pick the kernel your SPH solver used so interpolated values are consistent with the simulation. {"type":"typed proxy","choices":["SPH Cubic Kernel","SPH Quartic Kernel","SPH Quintic Kernel","SPH Wendland Quintic Kernel"]} native initialisation / omitted {"type":"SPH Cubic Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
MassArray Specify the mass array name. If not specified, then the mass at each point will be computed from the density and local (spherical) volume at a each point. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
NullPointsStrategy Specify a strategy to use when encountering a "null" point during the interpolation process. Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value (specified in the output point data). {"type":"enum","values":["Mask Points","Null Value"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
ShepardSumArrayName If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → SPH Cubic Kernel#

Syntax: {"type":"SPH Cubic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHCubicKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quartic Kernel#

Syntax: {"type":"SPH Quartic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuarticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2.5 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quintic Kernel#

Syntax: {"type":"SPH Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 3 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Wendland Quintic Kernel#

Syntax: {"type":"SPH Wendland Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHWendlandQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSPHDatasetInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "Source": "UPSTREAM_Source"
  }
}

pvSPHLineInterpolator#

Interpolates SPH particle data (Input) with SPH kernels onto a high-resolution straight line set in the Source options (Point1, Point2, Resolution; ParaView default 1000 intervals), producing a polyline profile with the interpolated arrays and a Shepard-sum array, e.g. a density or pressure profile through a particle simulation.

Common mistakes and assumptions:

  • The line endpoints may be derived by ParaView from the input bounds, but Schemaxis has not verified that; their static default is [0, 0, 0] for both, a degenerate line. Set Point1 and Point2 explicitly in dataset coordinates.
  • The kernel SpatialStep (smoothing length h) defaults to 0.0001; set it to the simulation's smoothing length in dataset units, or neighbourhoods are tiny and most output points become null points.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SPHLineInterpolator. Identity: filters/SPHLineInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeShepardSum Indicate whether to compute the summation of Shepard coefficients. In the interior of a SPH point cloud, the Shephard summation value should be ~1.0. Towards the boundary, the Shepard summation is less than 1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. {"type":"boolean"} native initialisation / omitted false
DensityArray Specify the density array name. This is required in computation. If not specified the code will error out. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
DerivativeArrays Specify the arrays whose derivative is to be taken. If the name of the array is "derivArray" this will produce an output array with the name "derivArray_deriv" (after filter execution). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ExcludedArrays Specify arrays which are to be excluded from the interpolation process. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Kernel Smoothing kernel W(r, h) used to weight neighbouring particles, following D.J. Price's SPH formulations. All four take the kernel options SpatialStep (the smoothing length h, in dataset units) and Dimension (1 to 3, the dimension of the particle problem, which sets the normalization). They differ in order and support radius: SPH Cubic Kernel (cutoff 2h, cheapest and least smooth), SPH Quartic Kernel (2.5h), SPH Quintic Kernel (3h, higher order, the ParaView default) and SPH Wendland Quintic Kernel (2h, a compactly supported Wendland function). Pick the kernel your SPH solver used so interpolated values are consistent with the simulation. {"type":"typed proxy","choices":["SPH Cubic Kernel","SPH Quartic Kernel","SPH Quintic Kernel","SPH Wendland Quintic Kernel"]} native initialisation / omitted {"type":"SPH Cubic Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
MassArray Specify the mass array name. If not specified, then the mass at each point will be computed from the density and local (spherical) volume at a each point. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
NullPointsStrategy Specify a strategy to use when encountering a "null" point during the interpolation process. Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value (specified in the output point data). {"type":"enum","values":["Mask Points","Null Value"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
ShepardSumArrayName If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Line"]} native initialisation / omitted {"type":"Line"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → SPH Cubic Kernel#

Syntax: {"type":"SPH Cubic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHCubicKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quartic Kernel#

Syntax: {"type":"SPH Quartic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuarticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2.5 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quintic Kernel#

Syntax: {"type":"SPH Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 3 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Wendland Quintic Kernel#

Syntax: {"type":"SPH Wendland Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHWendlandQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Line#

Syntax: {"type":"Line","options":{...}}. Native identity: extended_sources/HighResLineSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.Point1 Start point [x, y, z] of the line, in the input’s coordinates; the first seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Point2 End point [x, y, z] of the line, in the input’s coordinates; the last seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Resolution Number of equal segments of the probe line; the line has Resolution + 1 sample points, each receiving interpolated values. Higher values give a finer profile along the line. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSPHLineInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSPHPlaneInterpolator#

Interpolates SPH particle data (Input) with SPH kernels onto a bounded plane set in the Source options (Center, Normal, BoundingBox, Padding, Resolution or CellSize), producing a planar grid of SPH-weighted values for heat-map sections through a particle simulation.

Common mistakes and assumptions:

  • The plane's bounding box may be derived by ParaView from the input bounds, but Schemaxis has not verified that (static default [0, 1, 0, 1, 0, 1]); set BoundingBox, Center and Normal explicitly.
  • The kernel SpatialStep (smoothing length h) defaults to 0.0001; set it to the simulation's smoothing length in dataset units, or neighbourhoods are tiny and most output points become null points.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SPHPlaneInterpolator. Identity: filters/SPHPlaneInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeShepardSum Indicate whether to compute the summation of Shepard coefficients. In the interior of a SPH point cloud, the Shephard summation value should be ~1.0. Towards the boundary, the Shepard summation is less than 1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. {"type":"boolean"} native initialisation / omitted false
DensityArray Specify the density array name. This is required in computation. If not specified the code will error out. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
DerivativeArrays Specify the arrays whose derivative is to be taken. If the name of the array is "derivArray" this will produce an output array with the name "derivArray_deriv" (after filter execution). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ExcludedArrays Specify arrays which are to be excluded from the interpolation process. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Kernel Smoothing kernel W(r, h) used to weight neighbouring particles, following D.J. Price's SPH formulations. All four take the kernel options SpatialStep (the smoothing length h, in dataset units) and Dimension (1 to 3, the dimension of the particle problem, which sets the normalization). They differ in order and support radius: SPH Cubic Kernel (cutoff 2h, cheapest and least smooth), SPH Quartic Kernel (2.5h), SPH Quintic Kernel (3h, higher order, the ParaView default) and SPH Wendland Quintic Kernel (2h, a compactly supported Wendland function). Pick the kernel your SPH solver used so interpolated values are consistent with the simulation. {"type":"typed proxy","choices":["SPH Cubic Kernel","SPH Quartic Kernel","SPH Quintic Kernel","SPH Wendland Quintic Kernel"]} native initialisation / omitted {"type":"SPH Cubic Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
MassArray Specify the mass array name. If not specified, then the mass at each point will be computed from the density and local (spherical) volume at a each point. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
NullPointsStrategy Specify a strategy to use when encountering a "null" point during the interpolation process. Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value (specified in the output point data). {"type":"enum","values":["Mask Points","Null Value"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
ShepardSumArrayName If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Bounded Plane"]} native initialisation / omitted {"type":"Bounded Plane"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → SPH Cubic Kernel#

Syntax: {"type":"SPH Cubic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHCubicKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quartic Kernel#

Syntax: {"type":"SPH Quartic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuarticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2.5 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quintic Kernel#

Syntax: {"type":"SPH Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 3 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Wendland Quintic Kernel#

Syntax: {"type":"SPH Wendland Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHWendlandQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Bounded Plane#

Syntax: {"type":"Bounded Plane","options":{...}}. Native identity: extended_sources/BoundedPlaneSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.BoundingBox Axis-aligned region [xmin, xmax, ymin, ymax, zmin, zmax] that limits the plane: the output is the part of the plane inside this box (after Padding). The box is also the domain of the internal sampling grid, so a larger box at the same Resolution gives coarser spacing. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
Source.options.CellSize Edge length of the cubic grid cells when RefinementMode is “Use cell-size”: the box gets ceil(length / CellSize) cells per axis and is re-centred, so it may grow slightly. Smaller values give more samples. Ignored for “Use resolution”. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Source.options.Center A point the sampling plane passes through. With Normal it fixes the plane; keep it inside BoundingBox. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Normal Direction perpendicular to the sampling plane; its length does not matter. [0, 0, 1] gives a plane parallel to the x–y plane. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Padding Distance added on every side of BoundingBox before the plane is generated, so samples can extend slightly beyond the data. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Source.options.RefinementMode “Use resolution” divides the (padded) box into Resolution equal cells along every axis, so the spacing differs per axis when the box is not cubic; “Use cell-size” uses cubic cells of edge CellSize, giving the same spacing in every direction. {"type":"enum","values":["Use resolution","Use cell-size"]} native initialisation / omitted "Use resolution"
Source.options.Resolution Number of grid divisions along each axis of the padded box when RefinementMode is “Use resolution” (the same value on all three axes). The plane’s sample points lie where it crosses this grid, so higher values give denser sampling. Ignored for “Use cell-size”. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSPHPlaneInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSPHVolumeInterpolator#

Interpolates SPH particle data (Input) with SPH kernels onto a bounded volume set in the Source options (Origin, Scale, Padding, Resolution or CellSize), producing image data that can be contoured, sliced or volume-rendered as a continuous field.

Common mistakes and assumptions:

  • The volume's origin and extent may be derived by ParaView from the input bounds, but Schemaxis has not verified that (static defaults origin [0, 0, 0], scale [1, 1, 1]); set Origin, Scale and Resolution explicitly.
  • The kernel SpatialStep (smoothing length h) defaults to 0.0001; set it to the simulation's smoothing length in dataset units, or neighbourhoods are tiny and most output points become null points.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SPHVolumeInterpolator. Identity: filters/SPHVolumeInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The data source to be interpolated onto the Source. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). The input needs at least one point-centred array with 1 component. The input needs at least one point-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeShepardSum Indicate whether to compute the summation of Shepard coefficients. In the interior of a SPH point cloud, the Shephard summation value should be ~1.0. Towards the boundary, the Shepard summation is less than 1.0. If ComputeShepardSum is specified, then the output will contain an array of summed Shepard weights for each output point. {"type":"boolean"} native initialisation / omitted false
DensityArray Specify the density array name. This is required in computation. If not specified the code will error out. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
DerivativeArrays Specify the arrays whose derivative is to be taken. If the name of the array is "derivArray" this will produce an output array with the name "derivArray_deriv" (after filter execution). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ExcludedArrays Specify arrays which are to be excluded from the interpolation process. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Kernel Smoothing kernel W(r, h) used to weight neighbouring particles, following D.J. Price's SPH formulations. All four take the kernel options SpatialStep (the smoothing length h, in dataset units) and Dimension (1 to 3, the dimension of the particle problem, which sets the normalization). They differ in order and support radius: SPH Cubic Kernel (cutoff 2h, cheapest and least smooth), SPH Quartic Kernel (2.5h), SPH Quintic Kernel (3h, higher order, the ParaView default) and SPH Wendland Quintic Kernel (2h, a compactly supported Wendland function). Pick the kernel your SPH solver used so interpolated values are consistent with the simulation. {"type":"typed proxy","choices":["SPH Cubic Kernel","SPH Quartic Kernel","SPH Quintic Kernel","SPH Wendland Quintic Kernel"]} native initialisation / omitted {"type":"SPH Cubic Kernel"}
Locator Specify a point locator. {"type":"typed proxy","choices":["Static Point Locator"]} native initialisation / omitted {"type":"Static Point Locator"}
MassArray Specify the mass array name. If not specified, then the mass at each point will be computed from the density and local (spherical) volume at a each point. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
NullPointsStrategy Specify a strategy to use when encountering a "null" point during the interpolation process. Null points occur when the local neighborhood (of nearby points to interpolate from) is empty. If the strategy is set to MaskPoints, then an output array is created that marks points as being valid (=1) or null (invalid =0) (and the NullValue is set as well). If the strategy is set to NullValue, then the output data value(s) are set to the NullPoint value (specified in the output point data). {"type":"enum","values":["Mask Points","Null Value"]} native initialisation / omitted "Mask Points"
NullValue Specify the null point value. When a null point is encountered then all components of each null tuple are set to this value. By default the null value is set to zero. {"type":"number"} native initialisation / omitted 1
PassCellArrays Indicate whether to shallow copy the input cell data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassFieldArrays Indicate whether to shallow copy the input field data arrays to the output. {"type":"boolean"} native initialisation / omitted false
PassPointArrays Indicate whether to shallow copy the input point data arrays to the output. {"type":"boolean"} native initialisation / omitted false
ShepardSumArrayName If ComputeShepardSum is on, then an array is generated with name ShepardSumArrayName for each input point. This vtkFloatArray is placed into the output of the filter, and NullPoints have value =0.0. The default name is "Shepard Summation". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Source The data source that provides the structure to be interpolated on. {"type":"typed proxy","choices":["Bounded Volume"]} native initialisation / omitted {"type":"Bounded Volume"}
ValidPointsMaskArrayName If the NullPointsStrategy is "Mask Points", then an array is generated for each input point. This vtkCharArray is placed into the output of the filter, with a non-zero value for a valid point, and zero otherwise. The name of this masking array is specified here. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Nested Kernel → SPH Cubic Kernel#

Syntax: {"type":"SPH Cubic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHCubicKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quartic Kernel#

Syntax: {"type":"SPH Quartic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuarticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2.5 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Quintic Kernel#

Syntax: {"type":"SPH Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 3 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Kernel → SPH Wendland Quintic Kernel#

Syntax: {"type":"SPH Wendland Quintic Kernel","options":{...}}. Native identity: point_interpolation_kernels/SPHWendlandQuinticKernel. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Kernel.options.Dimension Spatial dimension of the particle data (1, 2 or 3). It selects the kernel’s normalization constant and the power of SpatialStep used for the default particle volume (SpatialStep^Dimension). Use 2 for planar simulations and 3 for volumetric ones. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1
Kernel.options.SpatialStep Smoothing length h of the kernel in dataset units. Neighbours are gathered within 2 × h of each sample (unless the operation supplies a cutoff array), weights are normalized by h^Dimension, and without a mass array each particle’s volume is taken as h^Dimension. Set it to the smoothing length or initial particle spacing of your simulation. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested Locator → Static Point Locator#

Syntax: {"type":"Static Point Locator","options":{...}}. Native identity: point_locators/StaticPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Locator.options.Automatic When true, the locator derives its bucket grid from the number of source points and NumberOfPointsPerBucket; when false, it uses Divisions exactly. {"type":"boolean"} native initialisation / omitted false
Locator.options.Divisions Bucket counts [nx, ny, nz] along x, y and z, used only when Automatic is false. Very fine grids waste memory on sparse clouds; very coarse grids make each search scan many points. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Locator.options.NumberOfPointsPerBucket Average number of source points per bucket targeted when Automatic is true; smaller values create more, smaller buckets. Ignored when Automatic is false. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested Source → Bounded Volume#

Syntax: {"type":"Bounded Volume","options":{...}}. Native identity: extended_sources/BoundedVolumeSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Source.options.CellSize Edge length of the cubic cells when RefinementMode is “Use cell-size”: the box gets ceil(length / CellSize) cells per axis and is re-centred, so it may grow slightly. Ignored for “Use resolution”. {"minimum":1.0,"type":"number"} native initialisation / omitted 1.0
Source.options.Origin Minimum corner [x, y, z] of the sampling box; the box extends to Origin + Scale along each positive axis. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Padding Distance added on every side of the box before sampling, so the volume can extend beyond the data. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Source.options.RefinementMode “Use resolution” divides the box into Resolution[i] cells along each axis (spacing may differ per axis); “Use cell-size” uses cubic cells of edge CellSize, giving equal spacing in every direction. {"type":"enum","values":["Use resolution","Use cell-size"]} native initialisation / omitted "Use resolution"
Source.options.Resolution Number of cells [nx, ny, nz] along each axis when RefinementMode is “Use resolution”; the volume has (nx + 1)(ny + 1)(nz + 1) sample points. Ignored for “Use cell-size”. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Source.options.Scale Edge lengths [Lx, Ly, Lz] of the sampling box. Despite the name they are absolute lengths added to Origin, not factors. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSPHVolumeInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSTEPReader#

Reads a STEP CAD file through OpenCASCADE and tessellates its B-rep faces into triangles, giving a multiblock dataset with one polydata block per shape (named from the file, or Unnamed) and a per-cell Colors array from the CAD colours. LinearDeflection and AngularDeflection set how closely the triangles follow curved surfaces; ReadWire adds edges as polylines. Use it to bring CAD geometry in for rendering, clipping or probing; use pvIGESReader for .iges, and readSTL or pvSTLReader for already-tessellated STL.

Common mistakes and assumptions:

  • VTK applies no unit conversion; compare the output bounds with the simulation's length unit before combining them.
  • LinearDeflection is an absolute distance in model units unless RelativeDeflection is on; the default 0.1 can be very coarse for small parts, so scale it to the model size.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: STEPReader. Identity: sources/STEPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AngularDeflection Limits the angle between two subsequent segments. {"type":"number"} native initialisation / omitted 1
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
LinearDeflection Limits the distance between a curve and the resulting tesselation. {"type":"number"} native initialisation / omitted 1
ReadWire Determines if 1D cells will be read. If enabled, surface boundaries are read. {"type":"boolean"} native initialisation / omitted false
RelativeDeflection Determines if the deflection values are relative to object size. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSTEPReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvSTLReader#

Full native STL reader: reads ASCII or binary stereolithography files (.stl) into triangle polydata, and a list of several files into a time series. In ParaView 5.13.3 this proxy exposes only the file list (the ScalarTags option of the core reader is not exposed). For a single CAD surface the curated readSTL does the same with one file.

Common mistakes and assumptions:

  • STL carries no units; check millimetres versus metres before combining with simulation data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: STLReader. Identity: sources/stlreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSTLReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvScatterPlot#

ParaView's Scatter Plot: passes a dataset through unchanged (vtkPassThrough) and marks it for the plot-matrix view, which shows every pair of arrays as a scatter plot in the ParaView GUI. In Schemaxis the data result is the unchanged input.

Common mistakes and assumptions:

  • No plot or table is computed; to get values for plotting, convert to a table, e.g. with pvExtractAttributes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ScatterPlot. Identity: filters/ScatterPlot. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvScatterPlot",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSegYReader#

Reads a SEG-Y seismic file. 3-D surveys become a structured grid (default) or, with StructuredGrid false, a lighter image data whose positions and shape may be approximate; 2-D lines become a structured grid sheet. Axes are crossline, inline and depth, and the trace samples are the point values. Trace positions come from source, CDP or custom header bytes, and VerticalCRS decides whether the vertical axis is height (positive up) or depth.

Common mistakes and assumptions:

  • The extended textual header is not read, so check VerticalCRS against the survey documentation.
  • In Custom XYCoordMode set both XCoordByte and YCoordByte: ParaView's initial YCoordByte is 76, not the SEG-Y source-Y byte 77.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: SegYReader. Identity: sources/SegY Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the SEG-Y reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Force2D Treats the file as a 2-D line even if it is a 3-D survey: the crossline and inline numbers are ignored and the traces are connected in file order into one structured-grid sheet through 3-D space. Use it for 2-D lines whose headers would otherwise be misread as 3-D. {"type":"boolean"} native initialisation / omitted false
StructuredGrid Specify if we create a Structured Grid even when the data is SEG-Y 3D. Note this consumes more memory but it shows the precise location for each point and the correct shape of the data. The default value is true. If we set this option to false we create an Image Data for a SEG-Y 3D dataset. {"type":"boolean"} native initialisation / omitted false
VerticalCRS Specify whether the vertical coordinates in the SEG-Y file are heights (positive up) or depths (positive down). By default, the vertical coordinates are treated as heights (i.e. positive up). This means that the Z-axis of the dataset goes from 0 (surface) to -ve depth (last sample). Note. As per the SEG-Y rev 2.0 specification, this information is defined in the Location Data Stanza of the Extended Textual Header. However, as of this revision, SegYReader does not support reading the extended textual header. {"type":"enum","values":["Heights","Depths"]} native initialisation / omitted "Heights"
XCoordByte One-based byte position in each trace header from which the trace x coordinate is read when XYCoordMode is Custom (Source uses bytes 73/77, CDP 181/185). Use it for files that store coordinates at non-standard positions. {"type":"integer"} native initialisation / omitted 1
XYCoordMode Specify whether to use source x/y coordinates or CDP coordinates or custom byte positions for data position in the SEG-Y trace header. Defaults to source x/y coordinates. As per SEG-Y rev 2.0 specification: - Source XY coordinate bytes = (73, 77) - CDP XY coordinate bytes = (181, 185) {"type":"enum","values":["Source","CDP","Custom"]} native initialisation / omitted "Source"
YCoordByte One-based byte position in each trace header from which the trace y coordinate is read when XYCoordMode is Custom (Source uses bytes 73/77, CDP 181/185). {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSegYReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvSelectionQuerySource#

Creates a query selection, ParaView's "Find Data" mechanism: QueryString is a structured query over the input's arrays, element indices or locations, evaluated per element when pvExtractSelection (or another extractor) runs; the elements where it is true are selected. ElementType chooses cells (ParaView default) or points, and Selectors can restrict the query to some blocks of a composite input. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. For a plain range on one array, pvThresholdSelectionSource is simpler.

Common mistakes and assumptions:

  • ParaView evaluates query text as Python (vtkPythonSelector, paraview.detail.calculator), so Schemaxis accepts only the structured QueryString, generates the text itself and checks it again before assignment; the selection still needs a ParaView build with Python and numpy.
  • Leave ContentType at 9 (QUERY) and FieldTypeOption at 1; the other values make this source produce a different, empty selection type.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SelectionQuerySource. Identity: sources/SelectionQuerySource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specify selectors to choose blocks to show for composite datasets. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
ContentType Native vtkSelectionNode content-type code of the produced selection: 0 GLOBALIDS, 1 PEDIGREEIDS, 2 VALUES, 3 INDICES, 4 FRUSTUM, 5 LOCATIONS, 6 THRESHOLDS, 7 BLOCKS, 8 BLOCK_SELECTORS, 9 QUERY, 10 USER. Only 9 makes this source emit the query; the other types need ID or value lists that this proxy cannot supply. {"type":"integer"} native initialisation / omitted 1
ElementType Kind of element the query selects. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data" or "Row Data". This source has no input, so all five texts are always accepted; ParaView checks the element type against the data only when the selection is extracted. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data"]} native initialisation / omitted "Point Data"
FieldTypeOption Which property decides the element association: 1 uses ElementType (vtkDataObject attribute codes), 0 uses vtkSelectionSource's own FieldType, which this proxy does not expose and which stays at its VTK default, CELL. {"type":"integer"} native initialisation / omitted 1
HierarchicalIndex Zero-based dataset (box) index within the AMR level given by HierarchicalLevel, restricting the query to that box of an overlapping-AMR input. The restriction is applied only when both HierarchicalLevel and HierarchicalIndex are 0 or greater; -1 means no restriction. {"type":"integer"} native initialisation / omitted 1
HierarchicalLevel Zero-based AMR refinement level to which the query is restricted, together with HierarchicalIndex; both must be 0 or greater for the restriction to apply. -1 means all levels. {"type":"integer"} native initialisation / omitted 1
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
ProcessID Zero-based MPI rank whose data the query is limited to; -1 applies it on every process. In a serial run there is only rank 0, so -1 and 0 behave alike. {"type":"integer"} native initialisation / omitted 1
QueryString The elements to select, written as a structured query instead of Python text. "any" lists alternative groups; each group's "all" lists clauses that must all hold; each clause applies one test to an array, an array component or magnitude, or the element index. Schemaxis compiles it to ParaView's Find Data expression and checks the result again before assignment. {"properties":{"any":{"items":{"properties":{"all":{"items":{"properties":{"array":{"maxLength":256,"minLength":1,"type":"string"},"component":{"maximum":255,"minimum":0,"type":"integer"},"ids":{"type":"boolean"},"magnitude":{"type":"boolean"},"maximum":{"type":"number"},"minimum":{"type":"number"},"negate":{"type":"boolean"},"point":{"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"},"test":{"required":true,"type":"enum","values":["==","!=","<","<=",">",">=","between","oneOf","isMinimum","isMaximum","isMinimumPerBlock","isMaximumPerBlock","isNaN","atMostMean","atLeastMean","nearMean","pointNear","cellContaining"]},"tolerance":{"minimum":0,"type":"number"},"value":{"type":"number"},"values":{"items":{"type":"number"},"maxItems":256,"minItems":1,"type":"array"}},"type":"object"},"maxItems":16,"minItems":1,"required":true,"type":"array"}},"type":"object"},"maxItems":16,"minItems":1,"required":true,"type":"array"}},"type":"object"} required {"any":[{"all":[{"test":"=="}]}]}
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false
Selectors For composite datasets, specify selectors to limit the view to a chosen subset of blocks. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSelectionQuerySource",
  "options": {
    "QueryString": {
      "any": [
        {
          "all": [
            {
              "test": "=="
            }
          ]
        }
      ]
    }
  }
}

pvShrink#

Moves the points of every cell toward that cell's centroid (average of its points) by ShrinkFactor, separating cells so individual elements become visible; output is an unstructured grid with unshared points. It is a mesh-inspection aid, not a geometric operation for measurements; the curated shrink offers the same with a Schemaxis default.

Common mistakes and assumptions:

  • Shrunk cells no longer share points, so connectivity-based operations see disjoint cells.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Shrink. Identity: filters/ShrinkFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Shrink filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ShrinkFactor The value of this property determines how far the points will move. A value of 0 positions the points at the centroid of the cell. A value of 1 leaves them at their original positions. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvShrink",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSlice#

ParaView's general Slice filter: cuts any dataset (or hyper tree grid) with an implicit surface (Plane, Box, Sphere or Cylinder) and returns polygonal data, i.e. surfaces from volumes and lines from surfaces, with point data interpolated. SliceOffsetValues produces several parallel copies of the cut surface in one node, and Crinkle slice instead keeps the whole input cells crossed by the surface. Use slice for a simple plane with Schemaxis defaults, pvSliceWithPlane for a faster multithreaded plane cut, or pvAxisAlignedSlice for hyper tree grids.

Common mistakes and assumptions:

  • Unless set, the plane origin and normal are ParaView's initial values, which may depend on the input bounds; set SliceType options explicitly for reproducible cuts.
  • For Sphere, Cylinder and Box slice types an offset is a value of the implicit function, not a distance; see SliceOffsetValues.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Slice. Identity: filters/Cut. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Slice filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Crinkleslice This parameter controls whether to extract the entire cells that are sliced by the region or just extract a triangulated surface of that region. {"type":"boolean"} native initialisation / omitted false
HyperTreeGridSlicer This property sets the parameters of the slice function. {"type":"typed proxy","choices":["Axis Aligned Plane","Plane"]} native initialisation / omitted {"type":"Axis Aligned Plane"}
PointMergeMethod This property specifies which incremental point locator to use for handling duplicate/coincident points. {"type":"typed proxy","choices":["Not Merging Points","Octree Binning","Uniform Binning"]} native initialisation / omitted {"type":"Uniform Binning"}
SliceOffsetValues The values in this property specify a list of current offset values. This can be used to create multiple slices with different centers. Each entry represents a new slice with its center shifted by the offset value. The 'Values Range' information is the range based on the global bounding box, not necessarily on the current slice geometry configuration. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
SliceType This property sets the parameters of the slice function. {"type":"typed proxy","choices":["Box","Cylinder","Plane","Sphere"]} native initialisation / omitted {"type":"Box"}
Triangulatetheslice This parameter controls whether to produce triangles in the output. {"type":"boolean"} native initialisation / omitted false
UseDual If checked, uses the dual of the hyper tree grid. {"type":"boolean"} native initialisation / omitted false

Nested HyperTreeGridSlicer → Axis Aligned Plane#

Syntax: {"type":"Axis Aligned Plane","options":{...}}. Native identity: implicit_functions/Axis Aligned Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridSlicer.options.AlwaysSnapToNearestAxis When true, ParaView replaces Normal by the coordinate axis of its largest absolute component, so the plane is always perpendicular to x, y or z. The snapped normal is always positive ([-1, 0, 0] becomes [1, 0, 0]), and tied components are all set to 1 ([1, 1, 0] stays [1, 1, 0]) rather than resolved to one axis. When false, Normal is used as given. {"type":"boolean"} native initialisation / omitted false
HyperTreeGridSlicer.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridSlicer.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
HyperTreeGridSlicer.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested HyperTreeGridSlicer → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
HyperTreeGridSlicer.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
HyperTreeGridSlicer.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
HyperTreeGridSlicer.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested PointMergeMethod → Not Merging Points#

Syntax: {"type":"Not Merging Points","options":{...}}. Native identity: incremental_point_locators/NonMergingPointLocator. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Divisions Bucket counts along x, y and z inherited from the uniform point locator. Points are inserted without any duplicate search, so this has no effect on the output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PointMergeMethod.options.Numberofpointsperbucket Average bucket occupancy inherited from the uniform point locator; with direct insertion it has no effect on the output. {"type":"integer"} native initialisation / omitted 1

Nested PointMergeMethod → Octree Binning#

Syntax: {"type":"Octree Binning","options":{...}}. Native identity: incremental_point_locators/IncrementalOctreeMergePoints. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Maxnumberofpointsperleaf Maximum number of points an octree leaf holds before it is split into eight children. Smaller values build a deeper tree (more construction work, quicker searches inside each leaf); larger values do the opposite. Affects speed and memory only. {"maximum":256,"minimum":16,"type":"integer"} native initialisation / omitted 16
PointMergeMethod.options.Tolerance Distance within which a new point is treated as an existing one and merged. ParaView fixes it at 0 for this choice and hides it, as its XML instructs (always zero for merging); a positive value would also merge distinct points closer than this distance, altering the geometry. {"type":"number"} native initialisation / omitted 1

Nested PointMergeMethod → Uniform Binning#

Syntax: {"type":"Uniform Binning","options":{...}}. Native identity: incremental_point_locators/MergePoints. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PointMergeMethod.options.Divisions Number of buckets along x, y and z of the uniform search grid used to find coincident points. It affects speed and memory only, never which points merge (only identical coordinates merge). VTK’s automatic sizing is on by default for this locator and ParaView does not expose it, so whenever the operation supplies an estimated point count the grid is sized from Number of points per bucket instead and Divisions is not used. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PointMergeMethod.options.Numberofpointsperbucket Target average number of points per bucket when the bucket grid is sized automatically (bucket count = estimated point count / this value). Smaller values create more, smaller buckets. Affects speed and memory only. {"type":"integer"} native initialisation / omitted 1

Nested SliceType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: implicit_functions/Box. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Bounds Reference box [xmin, xmax, ymin, ymax, zmin, zmax] used only when UseReferenceBounds is true; the box is then these bounds scaled by Length, rotated by Rotation and translated by Position, all about the coordinate origin, so Length [1, 1, 1], Rotation [0, 0, 0] and Position [0, 0, 0] reproduce Bounds exactly. Ignored otherwise. {"items":{"type":"number"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
SliceType.options.Length With UseReferenceBounds false: edge lengths [Lx, Ly, Lz] of the box along its own axes (ParaView applies them as scale factors to a unit cube). With UseReferenceBounds true: dimensionless scale factors applied to the Bounds box about the coordinate origin. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Position With UseReferenceBounds false: world coordinates [x, y, z] of the box’s minimum corner (before rotation); the box extends from Position to Position + Length along its own axes. With UseReferenceBounds true: a translation applied to the transformed Bounds box. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Rotation Rotation angles [rx, ry, rz] about the x, y and z axes, applied about the box’s local origin (its minimum corner at Position, not its centre; with UseReferenceBounds true, about the coordinate origin). The angles are combined in VTK’s Z-X-Y convention: the box transform is Translate · RotateZ · RotateX · RotateY · Scale. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.UseReferenceBounds Chooses how the box is defined. False: the box is a unit cube scaled by Length, rotated about its corner and placed at Position. True: the box starts from Bounds, and Length, Rotation and Position act as scale, rotation and translation relative to it (about the coordinate origin). {"type":"boolean"} native initialisation / omitted false

Nested SliceType → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: implicit_functions/Cylinder. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Axis Direction [ax, ay, az] of the cylinder's axis line through Center; the cylinder is infinitely long in both directions. For ordinary datasets ParaView normalizes the vector, so only its direction matters. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Center Any point [x, y, z] on the cylinder’s axis line. Moving it along Axis changes nothing; moving it sideways moves the cylinder. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Radius Distance from the axis line to the cylinder surface; points closer than this are inside. {"type":"number"} native initialisation / omitted 1

Nested SliceType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
SliceType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested SliceType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: implicit_functions/Sphere. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SliceType.options.Center Centre [x, y, z] of the sphere in the input’s coordinates; the region within Radius of this point is inside. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SliceType.options.Radius Radius of the sphere: points closer than Radius to Center are inside. A larger radius encloses more of the data or moves the cut shell outward. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSlice",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSliceAlongPolyLine#

Cuts a dataset with the curtain surface swept by moving a polyline parallel to the z-axis, like a vertical cross-section along a ship track, river or flight path. Connect the dataset to Dataset and the path (polydata containing a polyline) to PolyLine; the result is polygonal data with interpolated attributes. Only the polyline's x-y path matters. For a single straight cut use pvSlice or slice.

Common mistakes and assumptions:

  • The sweep direction is always the z-axis; rotate the data first (transform) if the vertical direction of your model is another axis.
  • If parts of the curtain are missing, increase Tolerance.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SliceAlongPolyLine. Identity: filters/SliceAlongPolyLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Dataset Required data input for the native Dataset port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the vtkDataObject to slice. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
PolyLine Required data input for the native PolyLine port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the polyline to slice along. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Tolerance The threshold used internally to determine correspondence between the polyline and the output slice. If the output has sections missing, increasing this value may help. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSliceAlongPolyLine",
  "inputs": {
    "Dataset": "UPSTREAM_Dataset",
    "PolyLine": "UPSTREAM_PolyLine"
  }
}

pvSliceWithPlane#

Fast, multithreaded plane cut (vtkPVPlaneCutter) of any dataset, composite dataset, overlapping AMR or hyper tree grid, producing polygonal data with interpolated point data and transferred cell data. It accepts only planes (Plane or Axis Aligned Plane) and, for unstructured input, can build a sphere tree to accelerate repeated cuts. Choose it over pvSlice when a plane is all you need and speed matters, or when slicing AMR data at a chosen level; use pvSlice for spheres, boxes, cylinders or offset copies.

Common mistakes and assumptions:

  • Duplicated points along cell edges are not merged by default; enable Mergeduplicatedpointsintheslice before operations that need a connected surface, such as connectivity or feature edges.
  • Set the Plane options explicitly; ParaView's initial origin may depend on the input bounds.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SliceWithPlane. Identity: filters/SliceWithPlane. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the slice filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BuildHierarchy If enabled and input is not an Image Data, Tree hierarchy will be computed, for a faster slice computation. {"type":"boolean"} native initialisation / omitted false
BuildTree If enabled and input is not an Image Data, Sphere Tree will be computed, for a faster slice computation. {"type":"boolean"} native initialisation / omitted false
ComputeNormals If enabled, compute the normal on each cell. Since all output cells are coplanar, the normal generated is simply the normal of the plane used to slice with. By default, computing of normals is disabled. {"type":"boolean"} native initialisation / omitted false
GeneratePolygons If enabled and input is a vtkImageData, vtkStructuredGrid or vtkRectilinearGrid, output slice will consist of polygons instead of only triangles. {"type":"boolean"} native initialisation / omitted false
InterpolateAttributes If enabled, interpolate attribute data. By default this is enabled. Point data is always interpolated. Cell data is transferred unless input is an image data. {"type":"boolean"} native initialisation / omitted false
Level Set maximum slice resolution. {"type":"integer"} native initialisation / omitted 1
Mergeduplicatedpointsintheslice This parameter controls whether to merge duplicated points in the slice. {"type":"boolean"} native initialisation / omitted false
PlaneType This property sets the parameters of the plane function. {"type":"typed proxy","choices":["Axis Aligned Plane","Plane"]} native initialisation / omitted {"type":"Axis Aligned Plane"}
UseDual If checked, uses the dual of the hyper tree grid. {"type":"boolean"} native initialisation / omitted false
UseNativeCutter This property specifies whether the ParaView's generic dataset cutter is used instead of the specialized AMR cutter. {"type":"boolean"} native initialisation / omitted false

Nested PlaneType → Axis Aligned Plane#

Syntax: {"type":"Axis Aligned Plane","options":{...}}. Native identity: implicit_functions/Axis Aligned Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PlaneType.options.AlwaysSnapToNearestAxis When true, ParaView replaces Normal by the coordinate axis of its largest absolute component, so the plane is always perpendicular to x, y or z. The snapped normal is always positive ([-1, 0, 0] becomes [1, 0, 0]), and tied components are all set to 1 ([1, 1, 0] stays [1, 1, 0]) rather than resolved to one axis. When false, Normal is used as given. {"type":"boolean"} native initialisation / omitted false
PlaneType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PlaneType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
PlaneType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested PlaneType → Plane#

Syntax: {"type":"Plane","options":{...}}. Native identity: implicit_functions/Plane. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
PlaneType.options.Normal Direction perpendicular to the plane, [nx, ny, nz]. It orients the plane and defines its positive side: points toward which the normal points have positive implicit-function values Normal·(x − Origin), points on the other side negative; clip and extract operations use this sign to decide which side to keep. VTK does not normalize the vector, so its length scales the function value. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PlaneType.options.Offset Moves the plane along its normal without changing Origin: the plane actually used passes through Origin + Offset × Normal. Positive values move it toward the side the normal points to. {"type":"number"} native initialisation / omitted 1
PlaneType.options.Origin A point the plane passes through, as [x, y, z] in the input’s own coordinates. With Normal it defines the infinite plane Normal·(x − Origin) = 0 used to clip, slice, cut or select. Moving Origin along the normal shifts the plane; moving it within the plane changes nothing. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSliceWithPlane",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSmooth#

Laplacian smoothing of a polygonal surface: each point moves iteratively toward the average of its connected neighbours, for up to NumberofIterations (ParaView default 20) or until the largest motion falls below Convergence. VTK's relaxation factor of 0.01 keeps each step small. Connectivity, point count and arrays are unchanged. Use it to reduce noise or faceting of scanned or iso-surfaces; smooth is the curated version.

Common mistakes and assumptions:

  • Laplacian smoothing shrinks the surface and rounds edges; use few iterations when dimensions matter.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Smooth. Identity: filters/SmoothPolyDataFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Smooth filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Convergence The value of this property limits the maximum motion of any point. It is expressed as a fraction of the length of the diagonal of the bounding box of the input dataset. If the maximum point motion during a smoothing iteration is less than the value of this property, the smoothing operation terminates. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
NumberofIterations This property sets the maximum number of smoothing iterations to perform. More iterations produce better smoothing. {"minimum":0,"type":"integer"} native initialisation / omitted 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSmooth",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSpatioTemporalHarmonics#

Adds a point array SpatioTemporalHarmonics (set as active scalars) whose value at point x and time t is the sum over harmonics of A·sin(k·x + ω·t + φ), with t the requested pipeline time and x in dataset coordinates. It produces analytic, time-varying test fields, e.g. to check interpolation, temporal statistics or FFT workflows against known waves.

Common mistakes and assumptions:

  • The ParaView default harmonics are examples sized for bounds [-10, 10] and times in [0, 2π); give your own for other domains.
  • There is no 2π factor: ω and k are angular (radians per time unit and per length unit).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SpatioTemporalHarmonics. Identity: filters/SpatioTemporalHarmonics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Harmonics This property defines the harmonics that will be computed and summed on each point. Default values are only example values, that would make sense for a dataset of geometrical bounds [-10,10,-10,10,-10,10] and time values greater than or equal to 0 and less than 2*Pi. Complete tuples of 6 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSpatioTemporalHarmonics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSpatioTemporalHarmonicsUniformGrid#

Generates image data (a uniform grid with spacing 1 over WholeExtent) with a time-dependent point array "SpatioTemporalHarmonics" = Σ A·sin(ω·t + k·x + φ), summed over the listed harmonics, at each listed time step. The ParaView defaults give four harmonics and 20 time steps over one 2π period, so the animation loops. Use it to test temporal filters, animation and time-dependent exports with a known analytic field; use pvWavelet for a static analytic volume.

Common mistakes and assumptions:

  • Point coordinates equal the grid indices (spacing 1), so wave vectors are per index unit.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: SpatioTemporalHarmonicsUniformGrid. Identity: sources/SpatioTemporalHarmonicsSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Harmonics This property defines the harmonics that will be computed and summed on each point. By default, it generates harmonics in each direction, with parameters adapted to the default extent. Complete tuples of 6 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
TimeStepValues This property specifies the timestep values to generate. When generating a range, make sure to remove the max value for the loop to avoid time value duplication (0 == 2Pi). By default, it generates 20 timesteps from [0;2Pi[ for data loop. {"items":{"maximum":6.2832,"minimum":0.0,"type":"number"},"type":"array"} native initialisation / omitted [0.0]
WholeExtent The six values in the property indicate the X, Y, and Z extent of the output data. The first two numbers are the minimum and maximum X extent; the next two are the minimum and maximum Y extent; and the final two are the minimum and maximum Z extent. The numbers are inclusive, so values of -10, 10, -10, 10, -10, 10 indicate that the dimensions of the output will be 21 x 21 x 21. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSpatioTemporalHarmonicsUniformGrid"
}

pvSphere#

Creates a polygonal sphere (or a section of one) with point normals: radius Radius around Center, tessellated by ThetaResolution longitude and PhiResolution latitude divisions. StartTheta/EndTheta (around z, 0 to 360 degrees) and StartPhi/EndPhi (from +z at 0 to -z at 180 degrees) cut out partial spheres. Use it as reference geometry or a probe surface; the curated sphere operation offers Schemaxis defaults.

Common mistakes and assumptions:

  • ParaView's default resolution (8 × 8) is coarse; raise both resolutions for smooth rendering or accurate probing.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Sphere. Identity: sources/SphereSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center This property specifies the 3D coordinates for the center of the sphere. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
EndPhi The value of this property can be adjusted to form only a portion of a sphere. The value is measured in degrees. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
EndTheta The value of this property can be adjusted to form only a portion of a sphere. This value is measured in degrees. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
PhiResolution The value of this property represents the number of divisions between Start Phi and End Phi on the sphere. (See the Start Phi and End Phi properties.) The phi divisions are similar to latitude lines on the earth. {"minimum":3,"type":"integer"} native initialisation / omitted 3
Radius This property specifies the radius of the sphere. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
StartPhi To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Phi property should be 180 degrees. The value of this property can be adjusted to form only a portion of a sphere. Set the starting angle (in degrees) in the latitudinal direction. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
StartTheta To form a complete sphere, the value of this property should be 0 degrees, and the value of the End Theta property should be 360 degrees. The value of this property can be adjusted to form only a portion of a sphere. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
ThetaResolution The value of this property represents the number of divisions between Start Theta and End Theta around the sphere. (See the Start Theta and End Theta properties.) The theta divisions are similar to longitude lines on the earth. The higher the resolution, the closer the approximation will come to a sphere, and the more polygons there will be. {"minimum":3,"type":"integer"} native initialisation / omitted 3

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSphere"
}

pvSplineSource#

Creates a smooth curve through control points: a parametric spline (ParametricFunction "Spline", with its own Points and Closed options) tessellated into a polyline of Resolution points. Use it for smooth seed or probe paths and annotation curves; pvPolyLineSource joins the points with straight segments instead.

Common mistakes and assumptions:

  • The spline interpolates the control points, so it can overshoot between widely spaced points; add control points to keep it in place.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: SplineSource. Identity: sources/SplineSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ParametricFunction Property used to reference the parametric function as data generator. {"type":"typed proxy","choices":["Spline"]} native initialisation / omitted {"type":"Spline"}
Resolution Set the spline resolution. {"minimum":2,"type":"integer"} native initialisation / omitted 2

Nested ParametricFunction → Spline#

Syntax: {"type":"Spline","options":{...}}. Native identity: parametric_functions/Spline. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
ParametricFunction.options.Closed When true, the spline forms a continuous loop, joining the last control point smoothly back to the first; when false it is an open curve from the first to the last point. {"type":"boolean"} native initialisation / omitted false
ParametricFunction.options.Points Control points as a flat list [x1, y1, z1, x2, y2, z2, …] in dataset units. The curve passes through each point in the listed order, so order matters and the list length must be a multiple of 3 (at least two points). Complete tuples of 3 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSplineSource"
}

pvSpyPlotReader#

Reads a CTH Spy Plot case: an ASCII .spcth case file listing the binary files that hold the data. Output port 0 is the volume data (a hierarchical composite of blocks with cell-centred arrays), port 1 the tracers and port 2 the markers. By ParaView default it derives material densities from selected material mass and volume fraction and merges X/Y/Z component arrays into vectors. Use pvRestartedSimSpyPlotReader for a restarted run split over several file sets and pvspcthhistoryreader for history files.

Common mistakes and assumptions:

  • Fields are cell-centred block data; convert with cellToPoint before operations that need point data, such as streamline tracing.
  • Derived densities need both Material Mass and Material Volume Fraction arrays selected.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SpyPlotReader. Identity: sources/spcthreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ComputeDerivedVariables If this property is set to 1, the reader will convert derived variables like material density for the materials that the user has selected. For Density the user needs to have selected Material Mass and Material Volume Fraction. {"type":"boolean"} native initialisation / omitted false
DistributeFiles In parallel mode, if this property is set to 1, the reader will distribute files or blocks. {"type":"boolean"} native initialisation / omitted false
DownConvertVolumeFraction If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char. {"type":"boolean"} native initialisation / omitted false
FileName This property specifies the file name for the Spy Plot reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
GenerateActiveBlockArray If this property is set to 1, a cell array will be generated that stores the active status of a block. {"type":"boolean"} native initialisation / omitted false
GenerateBlockIdArray If this property is set to 1, a cell array will be generated that stores a unique blockId for each block. {"type":"boolean"} native initialisation / omitted false
GenerateLevelArray If this property is set to 1, a cell array will be generated that stores the level of each block. {"type":"boolean"} native initialisation / omitted false
GenerateMarkers If this property is set to 1, a second output will be created using the markers data stored in the file. {"type":"boolean"} native initialisation / omitted false
GenerateTracers If this property is set to 1, a cell array will be generated that stores the coordinates of any tracers. {"type":"boolean"} native initialisation / omitted false
MergeXYZComponents If this property is set to 1, cell arrays named (for example) X velocity, Y velocity and Z velocity will be combined into a single vector array named velocity. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 3,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSpyPlotReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvStitchImageDataWithGhosts#

Joins image blocks that are separated by a one-voxel gap, such as blocks written independently by each process, by generating ghost points at the new interfaces, so the partitions behave as one continuous image. Input is image data or a composite of images with point data only. Use it before contouring or gradients on such tiled images to avoid gaps.

Common mistakes and assumptions:

  • Inputs with any cell data are rejected; remove cell arrays first (passArrays).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: StitchImageDataWithGhosts. Identity: filters/StitchImageDataWithGhosts. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet); image data (uniform rectilinear grids) (vtkImageData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberOfGhosts Number of ghost layers requested at each stitched interface. The value 1 only closes the one-voxel gap; each increment adds one ghost cell layer (n gives n - 1 layers) for filters that need wider stencils. {"maximum":10,"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvStitchImageDataWithGhosts",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvStreakLine#

Computes streaklines in an unsteady (time-dependent) vector field: particles are released from every SeedSource point at each input time step and advected through the changing field, and the particles released from the same place are joined into lines, the analogue of continuous dye injection. ParaView requests the input time steps itself, from the first step up to the requested time, so the input must have at least two time steps and a 3-component point vector field. Output is polydata (polylines, single points as vertices) with ParticleAge, ParticleId, InjectedPointId and the interpolated input arrays. Use pvStreamTracer for a steady snapshot and pvTemporalParticlesToPathlines to draw trails of existing particles.

Common mistakes and assumptions:

  • In the VTK used by ParaView 5.13.3 the streakline filter forces reinjection at every step, so ForceReinjectionEveryNSteps has no effect here; StaticSeeds and DisableResetCache are also no-ops.
  • Every requested time integrates from the first time step, which is slow on long series; restrict the input time range first.
  • Velocity must be point data; convert cell-centred solver output with cellToPoint.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: StreakLine. Identity: filters/StreakLine. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input list for the native Input port. List each upstream node to connect; each entry is a node name or a {node, port} object. ParaView: Specify which is the Input of the StreamTracer filter. Accepted data: any data object (vtkDataObject). The input needs at least one point-centred array with 3 components. True nonempty list data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input list for the native SeedSource port. List each upstream node to connect; each entry is a node name or a {node, port} object. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True nonempty list data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Compute vorticity and angular rotation of particles as they progress {"type":"boolean"} native initialisation / omitted false
DisableResetCache Has no effect in ParaView 5.13.3: the VTK setter is an empty deprecated stub (caching is now automated) and the getter always returns false, so the cache is handled the same way whatever value is set here. ParaView's own text says it stops the cache being reset so that new computations start from previous results; that no longer happens through this setting. {"type":"boolean"} native initialisation / omitted false
ForceReinjectionEveryNSteps Has no effect on this filter in ParaView 5.13.3: the streakline filter sets ForceReinjectionEveryNSteps to 1 every time it initialises, so particles are reinjected at every step whatever value is set here. ParaView's own text, which describes reinjection every Nth step, holds for the particle tracer (pvParticleTracer) but not for streaklines. {"type":"integer"} native initialisation / omitted 1
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MeshOverTime The input mesh can either be 1) different over time, or 2) static over time, or 3) a linear transformation of the first time step over time, or 4) have the same topology over time. If a value other than Different are used, then performance can be improved significantly because certain data structures, such as locators or cell links are not rebuilt for each timestep. {"type":"enum","values":["Different","Static","Linear Transformation","Same Topology"]} native initialisation / omitted "Different"
SelectInputVectors Specify which vector array should be used for the integration through that filter. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
StaticSeeds Has no effect on this filter in ParaView 5.13.3: StaticSeeds is only initialised and printed by vtkParticleTracerBase, which the filter derives from, and nothing in it reads the value. Only the legacy tracers read it (pvLegacyParticlePath, pvLegacyStreakLine and pvInSituParticlePath). ParaView's own text says that setting it to 1 avoids repeated grid searches for unchanging seeds; that holds for those operations, not for this one. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvStreakLine",
  "inputs": {
    "Input": [
      "UPSTREAM_Input"
    ],
    "SeedSource": [
      "UPSTREAM_SeedSource"
    ]
  }
}

pvStreamTracer#

Integrates steady streamlines through one time step of a 3-component vector field, forward, backward or both, from seeds made by the built-in SeedType generator (Point Cloud, the ParaView default, or Line). The output is polydata polylines carrying the input point arrays interpolated along each line, IntegrationTime, and cell arrays SeedIds and ReasonForTermination (1 left the domain, 4 maximum length, 5 maximum steps, 6 below terminal speed); with ComputeVorticity on (ParaView default) Vorticity, Rotation, AngularVelocity and Normals are added. Use the curated streamTracer for the common case, pvStreamTracerWithCustomSource to seed from another node's points, and pvStreakLine or pvTemporalParticlesToPathlines for unsteady flow.

Common mistakes and assumptions:

  • Step lengths default to Cell Length units (fractions of a cell), not dataset lengths; set IntegrationStepUnit to Length before giving steps in metres.
  • MaximumStreamlineLength has a static default of 1.0 that ParaView may replace with the input size; set it explicitly, or long streamlines can be cut short in large domains.
  • Cell-centred velocity is accepted, but vorticity is then 0; convert with cellToPoint first when vorticity or smooth interpolation matters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: StreamTracer. Identity: filters/StreamTracer. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Stream Tracer filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Specify whether to compute vorticity. {"type":"boolean"} native initialisation / omitted false
InitialStepLength This property specifies the initial integration step size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4), it is fixed (always equal to this initial value) throughout the integration. For an adaptive integrator (Runge-Kutta 4-5), the actual step size varies such that the numerical error is less than a specified threshold. {"type":"number"} native initialisation / omitted 1
IntegrationDirection This property determines in which direction(s) a streamline is generated. {"type":"enum","values":["FORWARD","BACKWARD","BOTH"]} native initialisation / omitted "FORWARD"
IntegrationStepUnit This property specifies the unit for Minimum/Initial/Maximum integration step size. The Length unit refers to the arc length that a particle travels/advects within a single step. The Cell Length unit represents the step size as a number of cells. {"type":"enum","values":["Length","Cell Length"]} native initialisation / omitted "Length"
IntegratorType This property determines which integrator (with increasing accuracy) to use for creating streamlines. {"type":"enum","values":["Runge-Kutta 2","Runge-Kutta 4","Runge-Kutta 4-5"]} native initialisation / omitted "Runge-Kutta 2"
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MaximumError This property specifies the maximum error (for Runge-Kutta 4-5) tolerated throughout streamline integration. The Runge-Kutta 4-5 integrator tries to adjust the step size such that the estimated error is less than this threshold. {"type":"number"} native initialisation / omitted 1
MaximumStepLength When using the Runge-Kutta 4-5 integrator, this property specifies the maximum integration step size. {"type":"number"} native initialisation / omitted 1
MaximumSteps This property specifies the maximum number of steps, beyond which streamline integration is terminated. {"type":"integer"} native initialisation / omitted 1
MaximumStreamlineLength This property specifies the maximum streamline length (i.e., physical arc length), beyond which line integration is terminated. {"type":"number"} native initialisation / omitted 1
MinimumStepLength When using the Runge-Kutta 4-5 integrator, this property specifies the minimum integration step size. {"type":"number"} native initialisation / omitted 1
SeedType The value of this property determines how the seeds for the streamlines will be generated. {"type":"typed proxy","choices":["Line","Point Cloud"]} native initialisation / omitted {"type":"Line"}
SurfaceStreamlines Specify whether to compute surface streamlines. {"type":"boolean"} native initialisation / omitted false
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
UseLocalSeedSource If true the filter considers that the whole seed source is available on all ranks. Else the filter will aggregate all seed sources from all ranks and merge their points. WARNING: do not set this value to true unless you know what you're doing. {"type":"boolean"} native initialisation / omitted false
Vectors This property contains the name of the vector array from which to generate streamlines. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Nested SeedType → Line#

Syntax: {"type":"Line","options":{...}}. Native identity: extended_sources/HighResLineSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SeedType.options.Point1 Start point [x, y, z] of the line, in the input’s coordinates; the first seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SeedType.options.Point2 End point [x, y, z] of the line, in the input’s coordinates; the last seed or sample point lies exactly here. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SeedType.options.Resolution Number of equal segments the seed line is divided into; the line has Resolution + 1 points and each one seeds a streamline, so this sets how many streamlines are traced. {"minimum":1,"type":"integer"} native initialisation / omitted 1

Nested SeedType → Point Cloud#

Syntax: {"type":"Point Cloud","options":{...}}. Native identity: extended_sources/PointSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
SeedType.options.Center Centre [x, y, z] of the spherical region in which the random seeds are placed, in the input’s coordinates. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
SeedType.options.NumberOfPoints Number of random seed points, and hence of streamlines started (per integration direction). {"minimum":1,"type":"integer"} native initialisation / omitted 1
SeedType.options.Radius Radius of the spherical seed region around Center; seeds fill its volume uniformly. 0 places every seed at Center. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvStreamTracer",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvStreamTracerWithCustomSource#

Integrates steady streamlines like pvStreamTracer, but every point of a second input (SeedSource) that lies inside the dataset starts a streamline, so any node's points can seed it: a probe line, a slice, an inlet patch or points read from a file. The vector field must be point-centred with 3 components. The output is polydata polylines carrying the input point arrays interpolated along each line, IntegrationTime, and cell arrays SeedIds and ReasonForTermination (1 left the domain, 4 maximum length, 5 maximum steps, 6 below terminal speed); with ComputeVorticity on (ParaView default) Vorticity, Rotation, AngularVelocity and Normals are added. With direction BOTH, N seeds give up to 2N lines.

Common mistakes and assumptions:

  • Step lengths default to Cell Length units (fractions of a cell), not dataset lengths; set IntegrationStepUnit to Length before giving steps in metres.
  • MaximumStreamlineLength has a static default of 1.0 that ParaView may replace with the input size; set it explicitly, or long streamlines can be cut short in large domains.
  • A seed source with thousands of points produces thousands of lines; use a coarser seed node.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: StreamTracerWithCustomSource. Identity: filters/ArbitrarySourceStreamTracer. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Stream Tracer filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
SeedSource Required data input for the native SeedSource port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeVorticity Specify whether to compute vorticity. {"type":"boolean"} native initialisation / omitted false
InitialStepLength This property specifies the initial integration step size. For non-adaptive integrators (Runge-Kutta 2 and Runge-Kutta 4), it is fixed (always equal to this initial value) throughout the integration. For an adaptive integrator (Runge-Kutta 4-5), the actual step size varies such that the numerical error is less than a specified threshold. {"type":"number"} native initialisation / omitted 1
IntegrationDirection This property determines in which direction(s) a streamline is generated. {"type":"enum","values":["FORWARD","BACKWARD","BOTH"]} native initialisation / omitted "FORWARD"
IntegrationStepUnit This property specifies the unit for Minimum/Initial/Maximum integration step size. The Length unit refers to the arc length that a particle travels/advects within a single step. The Cell Length unit represents the step size as a number of cells. {"type":"enum","values":["Length","Cell Length"]} native initialisation / omitted "Length"
IntegratorType This property determines which integrator (with increasing accuracy) to use for creating streamlines. {"type":"enum","values":["Runge-Kutta 2","Runge-Kutta 4","Runge-Kutta 4-5"]} native initialisation / omitted "Runge-Kutta 2"
InterpolatorType This property determines which interpolator to use for evaluating the velocity vector field. The first is faster though the second is more robust in locating cells during streamline integration. {"type":"enum","values":["Interpolator with Point Locator","Interpolator with Cell Locator"]} native initialisation / omitted "Interpolator with Point Locator"
MaximumError This property specifies the maximum error (for Runge-Kutta 4-5) tolerated throughout streamline integration. The Runge-Kutta 4-5 integrator tries to adjust the step size such that the estimated error is less than this threshold. {"type":"number"} native initialisation / omitted 1
MaximumStepLength When using the Runge-Kutta 4-5 integrator, this property specifies the maximum integration step size. {"type":"number"} native initialisation / omitted 1
MaximumSteps This property specifies the maximum number of steps, beyond which streamline integration is terminated. {"type":"integer"} native initialisation / omitted 1
MaximumStreamlineLength This property specifies the maximum streamline length (i.e., physical arc length), beyond which line integration is terminated. {"type":"number"} native initialisation / omitted 1
MinimumStepLength When using the Runge-Kutta 4-5 integrator, this property specifies the minimum integration step size. {"type":"number"} native initialisation / omitted 1
SurfaceStreamlines Specify whether to compute surface streamlines. {"type":"boolean"} native initialisation / omitted false
TerminalSpeed This property specifies the terminal speed, below which particle advection/integration is terminated. {"type":"number"} native initialisation / omitted 1
UseLocalSeedSource If true the filter considers that the whole seed source is available on all ranks. Else the filter will aggregate all seed sources from all ranks and merge their points. WARNING: do not set this value to true unless you know what you're doing. {"type":"boolean"} native initialisation / omitted false
Vectors This property contains the name of the vector array from which to generate streamlines. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvStreamTracerWithCustomSource",
  "inputs": {
    "Input": "UPSTREAM_Input",
    "SeedSource": "UPSTREAM_SeedSource"
  }
}

pvSubdivide#

Refines a triangle mesh linearly: each pass splits every triangle into four by adding a point at the midpoint of each edge, so the original surface shape and points are kept exactly while the resolution increases. Use it to give a coarse triangulated surface more points before interpolating onto it, warping or sampling. Input must be polydata of triangles (run triangulate first); use pvLoopSubdivision for a smoothed surface.

Common mistakes and assumptions:

  • Each pass quadruples the triangle count; four passes give 256 times as many triangles.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Subdivide. Identity: filters/Subdivide. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This parameter specifies the input to the Subdivide filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
NumberofSubdivisions The value of this property specifies the number of subdivision iterations to perform. {"maximum":4,"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSubdivide",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSuperquadric#

Creates a superquadric surface with normals and texture coordinates: one family covering ellipsoids, rounded boxes, cylinders and tori, chosen by the ThetaRoundness and PhiRoundness exponents (1 = round, near 0 = square-edged, above 1 = pinched). With Toroidal true (the ParaView default) it is a torus-like ring whose hole size is set by Thickness. Use it for test geometry or glyph shapes.

Common mistakes and assumptions:

  • ParaView's default is a torus (Toroidal true), unlike VTK's own default; set Toroidal false for an ellipsoid-like solid.
  • Size and Thickness are shape coefficients, so the overall extent is not exactly Size.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Superquadric. Identity: sources/SuperquadricSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center This property specifies the 3D coordinates of the center of the superquadric. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PhiResolution The value of this property represents the number of divisions in the phi (latitudinal) direction. This number will be rounded to the nearest multiple of 4. {"maximum":1024,"minimum":4,"type":"integer"} native initialisation / omitted 4
PhiRoundness This property defines the roundness in the phi (latitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes. {"minimum":0.01,"type":"number"} native initialisation / omitted 0.01
Scale The three values in this property are used to scale the superquadric in X, Y, and Z. The surface normals will be computed correctly even with anisotropic scaling. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Size The value of this property represents the isotropic size of the superquadric. Note that both the Size and Thickness properties control coefficients of superquadric generation, so the value of this property may not exactly describe the size of the superquadric. {"type":"number"} native initialisation / omitted 1
ThetaResolution The value of this property represents the number of divisions in the theta (longitudinal) direction. This value will be rounded to the nearest multiple of 8. {"maximum":1024,"minimum":8,"type":"integer"} native initialisation / omitted 8
ThetaRoundness This property defines the roundness of the superquadric in the theta (longitudinal) direction. A value of 0 represents a rectangular shape, a value of 1 represents a circular shape, and values greater than 1 produce higher order shapes. {"minimum":0.01,"type":"number"} native initialisation / omitted 0.01
Thickness If the value of the Toroidal property is 1, this value represents the thickness of the superquadric as a value between 0 and 1. A value close to 0 leads to a thin object with a large hole, and a value near 1 leads to a thick object with a very small hole. Changing the thickness does not change the outer radius of the superquadric. {"maximum":1.0,"minimum":0.0001,"type":"number"} native initialisation / omitted 0.0001
Toroidal If the value of this property is 0, the generated superquadric will not contain a hole (i.e., the superquadric will be ellipsoidal). Otherwise, a toroidal object is generated. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSuperquadric"
}

pvSurfaceFlow#

Computes the net flux of a point vector field through a surface: at each point it takes the dot product of the vector with a normal averaged from the neighbouring 2-D cells, then integrates it over the surface with Integrate Variables. The output is a one-point unstructured grid whose point array Surface Flow holds the integral (vector units times area), e.g. a volumetric flow rate when the vector is velocity. Use it on a slice, a boundary patch or any 2-D surface; integrate gives other surface integrals.

Common mistakes and assumptions:

  • Only 2-D cells (triangles, quads, polygons, pixels) contribute; feed a surface, not a volume mesh.
  • Point normals are made mutually consistent but their overall sign follows the first cell's orientation, so the flux sign may be reversed; check it against a known inflow.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SurfaceFlow. Identity: filters/IntegrateFlowThroughSurface. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Surface Flow filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SelectInputVectors The value of this property specifies the name of the input vector array containing the flow vector field. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSurfaceFlow",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSurfaceNormals#

Computes point normals (array Normals) on polygonal surfaces by averaging the normals of the polygons around each point, for smooth shading and for operations that need surface normals. By ParaView default polygon ordering is made consistent and points are split along edges sharper than FeatureAngle (30 degrees), keeping edges crisp but duplicating points; cell normals can be output too. The curated normals operation uses the same algorithm with Schemaxis defaults (splitting off).

Common mistakes and assumptions:

  • Splitting (default true) duplicates points along sharp edges, changing point count and connectivity; turn it off before operations that need the original points.
  • Normals follow polygon ordering; on open or inconsistently ordered surfaces some may point inward, so check orientation or use FlipNormals.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SurfaceNormals. Identity: filters/SurfaceNormals. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Normals Generation filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeCellNormals This filter computes the normals at the points in the data set. In the process of doing this it computes polygon normals too. If you want these normals to be passed to the output of this filter, set the value of this property to 1. {"type":"boolean"} native initialisation / omitted false
Consistency The value of this property controls whether consistent polygon ordering is enforced. Generally the normals for a data set should either all point inward or all point outward. If the value of this property is 1, then this filter will reorder the points of cells that whose normal vectors are oriented the opposite direction from the rest of those in the data set. {"type":"boolean"} native initialisation / omitted false
FeatureAngle The value of this property defines a feature edge. If the surface normal between two adjacent triangles is at least as large as this Feature Angle, a feature edge exists. If Splitting is on, points are duplicated along these feature edges. (See the Splitting property.) {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
FlipNormals If the value of this property is 1, this filter will reverse the normal direction (and reorder the points accordingly) for all polygons in the data set; this changes front-facing polygons to back-facing ones, and vice versa. You might want to do this if your viewing position will be inside the data set instead of outside of it. {"type":"boolean"} native initialisation / omitted false
NonManifoldTraversal Turn on/off traversal across non-manifold edges. Not traversing non-manifold edges will prevent problems where the consistency of polygonal ordering is corrupted due to topological loops. {"type":"boolean"} native initialisation / omitted false
PieceInvariant Turn this option to to produce the same results regardless of the number of processors used (i.e., avoid seams along processor boundaries). Turn this off if you do want to process ghost levels and do not mind seams. {"type":"boolean"} native initialisation / omitted false
Splitting This property controls the splitting of sharp edges. If sharp edges are split (property value = 1), then points are duplicated along these edges, and separate normals are computed for both sets of points to give crisp (rendered) surface definition. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSurfaceNormals",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSurfaceTangents#

Computes per-point tangent vectors (array Tangents) of a triangulated surface from its point normals and texture coordinates, as required for normal-map texturing in rendering. The input must be triangle polydata with point Normals and texture coordinates; the output is the same polydata with tangents added. Use it only for textured rendering; it has no analysis meaning.

Common mistakes and assumptions:

  • Missing normals or texture coordinates make the filter fail; run normals and a texture-mapping step (e.g. pvTextureMaptoPlane) first, and triangulate general polygons.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SurfaceTangents. Identity: filters/SurfaceTangents. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Tangents Generation filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeCellTangents This filter computes the tangents at the points in the data set. In the process of doing this it computes polygon tangents too. If you want these normals to be passed to the output of this filter, set the value of this property to 1. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSurfaceTangents",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSurfaceVectors#

Constrains a point vector field on a 2-D surface relative to the local surface normal (averaged from neighbouring 2-D cells). Parallel removes the normal component, leaving the tangential part (e.g. wall shear direction or surface streamlines); Perpendicular keeps only the normal component; PerpendicularScale outputs the signed normal component as a new scalar array named Perpendicular Scale. The modified vectors keep the input array name; geometry is unchanged. pvSurfaceFlow uses the PerpendicularScale mode internally to compute fluxes.

Common mistakes and assumptions:

  • Works on point vectors and 2-D cells only; volume cells are ignored when computing normals.
  • The normal sign follows the cell orientation, so PerpendicularScale values may have the opposite sign to the outward normal.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SurfaceVectors. Identity: filters/SurfaceVectors. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Surface Vectors filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ConstraintMode This property specifies whether the vectors will be parallel or perpendicular to the surface. If the value is set to PerpendicularScale (2), then the output will contain a scalar array with the dot product of the surface normal and the vector at each point. {"type":"enum","values":["Parallel","Perpendicular","PerpendicularScale"]} native initialisation / omitted "Parallel"
SelectInputVectors This property specifies the name of the input vector array to process. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSurfaceVectors",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvSynchronizeTime#

Snaps the time values of one dataset to those of another. DataToPass supplies the data and its time steps; any of its time values within RelativeTolerance × (its time range) of a TimeToSync time value is replaced by that value, so both sources report identical times, e.g. a simulation written at 0.1000001 s and experimental data at 0.1 s. The output keeps DataToPass's data and number of time steps; only the time labels change.

Common mistakes and assumptions:

  • Data are not interpolated in time; for different sampling use a temporal interpolator.
  • Two input steps that snap to the same value become ambiguous; ParaView warns about this.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: SynchronizeTime. Identity: filters/SynchronizeTime. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
DataToPass Required data input for the native DataToPass port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset whose geometry and fields will be output. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
TimeToSync Required data input for the native TimeToSync port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain the time step values. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
RelativeTolerance Fraction of the DataToPass time range within which a DataToPass time value is replaced by a TimeToSync time value: the absolute threshold is RelativeTolerance × (last time − first time). Larger values snap more distant times; 0 snaps nothing. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvSynchronizeTime",
  "inputs": {
    "DataToPass": "UPSTREAM_DataToPass",
    "TimeToSync": "UPSTREAM_TimeToSync"
  }
}

pvTIFFReader#

Reads one TIFF file (.tif, .tiff) into uniform image data; it is kept for backward compatibility, and pvTIFFSeriesReader reads the same files with stacking, time series and custom spacing added. Spacing comes from the TIFF resolution tags when present (converted to millimetres for inch or centimetre units), otherwise 1.

Common mistakes and assumptions:

  • Prefer pvTIFFSeriesReader in new documents.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TIFFReader. Identity: sources/TIFFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the TIFF reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTIFFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvTIFFSeriesReader#

Reads TIFF images (.tif, .tiff; 8- or 16-bit integer or 32-bit float) into uniform image data. Several files are stacked as z slices by default (ReadAsImageStack true) or read as a time series. Spacing comes from the TIFF resolution tags (millimetres for inch or centimetre units, otherwise 1) unless UseCustomDataSpacing applies CustomDataSpacing. Pair with pvWriteTIFFWriter for round trips; use pvOMETIFFReader for OME-TIFF.

Common mistakes and assumptions:

  • Resolution tags written for printing (e.g. 72 dpi) give spacings near 0.35 mm; set a custom spacing when the image represents physical data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TIFFSeriesReader. Identity: sources/TIFFSeriesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CustomDataSpacing Set the spacing to use for the image output by this reader. This is used only when UseCustomDataSpacing is set to true. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
FileNames The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
ReadAsImageStack When set, the reader will read the set of files as an image stack, rather than a temporal file series. {"type":"boolean"} native initialisation / omitted false
UseCustomDataSpacing To manually specify a custom spacing using CustomDataSpacing, set this property to 1 (checked). {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTIFFSeriesReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvTRUCHASReader#

Reads output of TRUCHAS (Los Alamos casting, solidification and heat-transfer code) stored in HDF5 into a multiblock dataset, with selectable mesh blocks and point and cell arrays at each stored time step. Use it to inspect temperature, phase fraction or flow fields of casting simulations.

Common mistakes and assumptions:

  • The block, point-array and cell-array selections have no static default; name them when the result depends on them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: TRUCHASReader. Identity: sources/TruchasReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Blocks Select the grids to be loaded from the dataset, if any. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName This property specifies the HDF5 file name Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTRUCHASReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvTableFFT#

Computes the discrete Fourier transform of every numeric column of a table (columns whose names start with vtk are skipped; 2-component columns are treated as complex), returning a table of spectra. The sampling rate is taken from a column named Time (any capitalization, assumed evenly spaced) or else from DefaultSampleRate (ParaView default 10000 Hz), and a Frequency column is added by default. Use it for spectra of probe histories, e.g. pressure fluctuations over time from a plot-over-time table; enable UseWelchMethod for an averaged, smoother spectrum of long noisy signals.

Common mistakes and assumptions:

  • Unevenly spaced time samples give wrong frequencies; resample the history to a constant step first.
  • Without a Time column the 10000 Hz default rate is used, which is almost never the true rate; add the time column or set DefaultSampleRate.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TableFFT. Identity: filters/TableFFT. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: tables (rows and columns) (vtkTable). The input needs at least one row (table) array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BlockOverlap Specify the number of samples which will overlap between each block / segment. If value is not in a valid range (ie inferior to 0 or superior to BlockSize) then the value BlockSize / 2 will be used. Only used if UseWelchMethod is true. {"type":"integer"} native initialisation / omitted 1
BlockSize Specify the number of samples to use for each block / segment in the Welch method. This should be a power of 2 in order to achieve better performance. {"type":"integer"} native initialisation / omitted 1
CreateFrequencyColumn Specify if the filter should create a frequency column based on a column named "time" (not case sensitive). An evenly-spaced time array is expected. {"type":"boolean"} native initialisation / omitted false
DefaultSampleRate If the "Time" column is not found then this value will be used as the sample rate of the input. {"maximum":100000.0,"minimum":10.0,"type":"number"} native initialisation / omitted 10.0
Detrend Remove trend on each segment before applying the FFT. This is a constant detrend where the mean of the signal is substracted to the signal. Only used if UseWelchMethod is true. {"type":"boolean"} native initialisation / omitted false
Normalize Specify if the output should be normalized. Only used if UseWelchMethod is false. {"type":"boolean"} native initialisation / omitted false
OneSidedSpectrum Specify if the filter should use the optimized discrete fourier transform for real values. This will cause output columns to have from n to ((n / 2) + 1) rows. {"type":"boolean"} native initialisation / omitted false
ScalingMethod Set what scaling should be used when applying the Welch method. {"type":"enum","values":["Density","Spectrum"]} native initialisation / omitted "Density"
UseWelchMethod Specify if filter should use the Welch / periodogram method. If true the input will be split in multiple segment to compute an average fft across all segments / blocks. This can be faster for input with lots of samples and also remove some noise. {"type":"boolean"} native initialisation / omitted false
WindowingFunction Specify the windowing function to apply on the input. This allows to better process data that is not periodic. When Welch method is used, the window is applied to each frame. {"type":"enum","values":["Rectangular (passthrough)","Hanning","Bartlett","Sine","Blackman"]} native initialisation / omitted "Rectangular (passthrough)"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTableFFT",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTableToPoints#

Turns a table (e.g. a CSV file of x, y, z samples) into polydata points: three numeric columns give the coordinates and the other columns become point arrays. The coordinate columns are removed from the arrays unless KeepAllDataArrays is on; with a2DPoints the Z column is ignored and z = 0. Use it to place measurement or particle data in space for probing, interpolation or glyphs.

Common mistakes and assumptions:

  • Name XColumn, YColumn and ZColumn explicitly; otherwise ParaView picks columns itself, possibly the wrong ones.
  • Coordinates are used as given; convert units (e.g. millimetres to metres) upstream if the mesh uses different units.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TableToPoints. Identity: filters/TableToPolyData. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: tables (rows and columns) (vtkTable). The input needs at least one row (table) array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
KeepAllDataArrays Keep columns specified as X,Y,Z as Data arrays. By default this will be off. {"type":"boolean"} native initialisation / omitted false
XColumn This property specifies which data array is going to be used as the X coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
YColumn This property specifies which data array is going to be used as the Y coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ZColumn This property specifies which data array is going to be used as the Z coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
a2DPoints Specify whether the points of the polydata are 3D or 2D. If this is set to true then the Z Column will be ignored and the Z value of each point on the polydata will be set to 0. By default this will be off. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTableToPoints",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTableToStructuredGrid#

Turns a table into a curvilinear structured grid: X, Y and Z columns give the point coordinates, row order is point order with i varying fastest, then j, then k, and the other columns become point arrays. WholeExtent gives the grid's index ranges, and the table must have exactly (imax-imin+1)(jmax-jmin+1)(kmax-kmin+1) rows. Use it for gridded data exported row by row, e.g. a CSV of a structured solver block; use pvTableToPoints for scattered points.

Common mistakes and assumptions:

  • With the ParaView default WholeExtent [0, 0, 0, 0, 0, 0] only a one-row table fits; always set the extent to match the table.
  • Rows must be ordered i fastest; a table sorted differently gives a scrambled grid.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TableToStructuredGrid. Identity: filters/TableToStructuredGrid. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: tables (rows and columns) (vtkTable). The input needs at least one row (table) array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
WholeExtent Index ranges of the structured grid as [imin, imax, jmin, jmax, kmin, kmax] (inclusive point indices). The number of points, (imax-imin+1)(jmax-jmin+1)(kmax-kmin+1), must equal the number of table rows, or ParaView reports an error and produces nothing. For a 2-D grid keep one range collapsed, e.g. kmin = kmax = 0. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
XColumn This property specifies which data array is going to be used as the X coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
YColumn This property specifies which data array is going to be used as the Y coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ZColumn This property specifies which data array is going to be used as the Z coordinate in the generated polydata dataset. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTableToStructuredGrid",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTecplotReader#

Reads ASCII Tecplot files (.dat, .tec, .tp) into a multiblock dataset with one block per zone; each block is a structured grid (ordered zones) or unstructured grid (finite-element zones). Point-packed zones give point data only; block-packed zones may carry point or cell data. Several files form a time series. Use pvTecplotTableReader for Tecplot data that is a plain table, and pvVisItTecplotBinaryReader for binary .plt files.

Common mistakes and assumptions:

  • This is a simplified ASCII reader; binary Tecplot files and some advanced format features are not supported.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: TecplotReader. Identity: sources/TecplotReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DataArrayStatus Names of the Tecplot variables to read as arrays on every zone; each variable becomes point or cell data according to the file's packing and VARLOCATION. Coordinate variables are not listed. Listing names is exclusive: ParaView switches every other available name off, so include all you need; an empty list reads none. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTecplotReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvTecplotTableReader#

Reads a Tecplot ASCII data file (.dat) as a table (vtkTable): one column per variable and one row per data record, with column names taken from a header line. It creates no geometry, so it suits point-wise or line data for plots and table exports. Use pvTecplotReader for Tecplot zone (mesh) data and pvCSVReader for comma-separated tables.

Common mistakes and assumptions:

  • If column names come out shifted or wrong, adjust Numberofheaderlines, Linewithcolumnnames and Skipcolumnnamefields to match the file's header.
  • MaxNumberofRecords limits the rows read for previewing; leave it at the default 0 for the full file.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: TecplotTableReader. Identity: sources/TecplotTableReaderCore. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The name of the file to read. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Linewithcolumnnames The line that contains the column names. {"type":"integer"} native initialisation / omitted 1
MaxNumberofRecords The maximum number of records to read. Use this to preview a file. {"type":"integer"} native initialisation / omitted 1
Numberofheaderlines The number of lines that form the header. {"type":"integer"} native initialisation / omitted 1
Skipcolumnnamefields Number of fields to skip while reading column names. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTecplotTableReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvTemporalArrayOperator#

Combines one array at two of the input's stored time steps, chosen by zero-based indices (FirstTimeStepIndex, SecondTimeStepIndex), with +, -, * or / applied value by value as first-operator-second. The output is the dataset at the second step plus one new array named after the input array with a suffix (by default _add, _sub, _mul or _div), e.g. p_sub for the pressure change between two saved times. Both steps must hold the array with the same number of tuples and components, so the mesh must not change. Use temporalStatistics or pvTemporalStatistics for averages over all steps.

Common mistakes and assumptions:

  • Both indices default to 0, which combines the first step with itself (ParaView only warns); set both.
  • The input must report at least two time steps; indices count stored steps from 0, they are not time values.
  • For integer arrays / is integer division; convert to floating point first (calculator).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalArrayOperator. Identity: filters/TemporalArrayOperator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the TemporalArrayOperator filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FirstTimeStepIndex This property specifies the timestep index to use in the first part of the comparison computation {"type":"integer"} native initialisation / omitted 1
Operator The property determines the operation to compute between the first and second timestep data. {"type":"enum","values":["+","-","*","/"]} native initialisation / omitted "+"
OutputArrayNameSuffix This property set the suffix to be append to the output array name. If empty, output will be suffixed with '_' and the operation type. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
SecondTimeStepIndex This property specifies the timestep index to use in the second part of the comparison computation {"type":"integer"} native initialisation / omitted 1
SelectInputArray This property lists the name of the array from which to use. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalArrayOperator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalCache#

Keeps copies of the input at up to CacheSize recently requested time steps (ParaView default 2, range 2 to 10) and returns a cached copy when the same time is requested again, instead of re-running the upstream pipeline. Data and time values are unchanged. It helps when downstream temporal filters, e.g. pvTemporalInterpolator, repeatedly request the same steps from an expensive reader or filter chain.

Common mistakes and assumptions:

  • Each cached step keeps a copy of the dataset in memory; keep CacheSize small for large meshes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalCache. Identity: filters/TemporalCache. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the Temporal Cache filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CacheSize The cache size determines the number of time steps that can be cached at one time. The maximum number is 10. The minimum is 2 (since it makes little sense to cache less than that). {"maximum":10,"minimum":2,"type":"integer"} native initialisation / omitted 2

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalCache",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalCacheSource#

The same cache as pvTemporalCache (vtkTemporalDataSetCache), registered by ParaView as a source with IsASource true, the configuration meant for Catalyst in-situ pipelines: it then reports only the times currently held in the cache as its time steps and keeps entries even when the upstream pipeline changes, so it can hold a short history of a live simulation. For post-processing stored results use pvTemporalCache.

Common mistakes and assumptions:

  • Because entries are not invalidated when upstream settings change, results can be stale; use pvTemporalCache in ordinary pipelines.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalCacheSource. Identity: sources/TemporalCache. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the Temporal Cache filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CacheSize The cache size determines the number of time steps that can be cached at one time. The maximum number is 10. The minimum is 2 (since it makes little sense to cache less than that). {"maximum":10,"minimum":2,"type":"integer"} native initialisation / omitted 2
IsASource Sets up the Algorithm to act as a pipeline source rather than a filter. This is used in Catalyst. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalCacheSource",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalInterpolator#

Linearly interpolates point coordinates and point and cell arrays between the two stored time steps around a requested time, so data can be obtained at times the input did not save; ParaView uses vtkAdaptiveTemporalInterpolator, which also copes when the mesh appears to change between steps. By ParaView default it reports the input's own steps; DiscreteTimeStepInterval reports evenly spaced steps instead and ResampleFactor adds steps inside each stored interval. The input needs at least two time steps, and interpolated values are a linear approximation, not solver results.

Common mistakes and assumptions:

  • Schemaxis updates every node at the scene time, and the curated foam reader rejects times it has not stored (TIME_UNAVAILABLE), so intermediate scene times are refused at a foam node before this filter runs.
  • Linear interpolation smooths over events between saved steps; save output more often when such detail matters.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalInterpolator. Identity: filters/TemporalInterpolator. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the Temporal Interpolator. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
DiscreteTimeStepInterval If Discrete Time Step Interval is set to 0, then the Temporal Interpolator will provide a continuous region of time on its output. If set to anything else, then the output will define a finite set of time points on its output, each spaced by the Discrete Time Step Interval. The output will have (time range)/(discrete time step interval) time steps. (Note that the time range is defined by the time range of the data of the input filter, which may be different from other pipeline objects or the range defined in the animation inspector.) This is a useful option to use if you have a dataset with one missing time step and wish to 'fill in' the missing data with an interpolated value from the steps on either side. {"type":"number"} native initialisation / omitted 1
ResampleFactor When ResampleFactor is a non zero positive integer, each pair of input time steps will be interpolated between with the number of steps specified. For example an input of 1,2,3,4,5 and a resample factor of 10, will produce steps 0f 1.0, 1.1, 1.2, ..., 1.9, 2.0. Irregular input steps will produce irregular output steps. Resample factor will only be used if DiscreteTimeStepInterval is zero, otherwise the DiscreteTimeStepInterval takes precedence {"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalInterpolator",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalParticlesToPathlines#

Builds trails from moving particles: it takes a point set whose points move between time steps (e.g. Lagrangian particles read from a solver, or a particle tracer's output) and joins each particle's successive positions into a polyline. ParaView loops over the input times itself up to the requested time. Output port 0 (Pathlines) holds the trails with TrailId and TrackLength; port 1 (Particles) holds one vertex at each trail's head. Particles are matched by IdChannelArray (global ids or point index by default). Use pvStreakLine to compute particle motion from a velocity field instead.

Common mistakes and assumptions:

  • By ParaView default only every 100th point is tracked (MaskPoints) and trails keep 25 steps; set MaskPoints to 1 and raise MaxTrackLength for complete paths.
  • If particles are reordered between steps, matching by index scrambles the trails; set IdChannelArray to a persistent particle id.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalParticlesToPathlines. Identity: filters/ParticlePathLines. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input cells for which to create pathlines. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
Selection Optional data input for the native Selection port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set a second input, which is a selection. Particles with the same Id in the selection as the primary input will be chosen for pathlines. Note that you must have the same IdChannelArray in the selection as the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). False one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
BackwardTime Compute particle path lines when time goes backward. {"type":"boolean"} native initialisation / omitted false
IdChannelArray Specify the name of a scalar array which will be used to fetch the index of each point. This is necessary only if the particles change position (Id order) on each time step. The Id can be used to identify particles at each step and hence track them properly. If this array is set to "Global or Local IDs", the global point ids are used if they exist or the point index is otherwise. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
KeepDeadTrails Keep the trails of particles that leave the domain. Use carefully as it may cause excessive memory consumption when generating many particle trails. {"type":"boolean"} native initialisation / omitted false
MaskPoints Set the number of particles to track as a ratio of the input. Example: setting MaskPoints to 10 will track every 10th point. {"type":"integer"} native initialisation / omitted 1
MaxStepDistance If a particle disappears from one end of a simulation and reappears on the other side, the track left will be unrepresentative. Set a MaxStepDistance{x,y,z} which acts as a threshold above which if a step occurs larger than the value (for the dimension), the track will be dropped and restarted after the step. That is, the part before the wrap around will be dropped and the newer part kept. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
MaxTrackLength If the particles being traced animate for a long time, the trails or traces will become long and stringy. Setting the MaxTraceTimeLength will limit how much of the trace is displayed. Tracks longer then the Max will disappear and the trace will appear like a snake of fixed length which progresses as the particle moves. This length is given with respect to timesteps. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalParticlesToPathlines",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalShiftScale#

Relabels time without touching the data: an input time t is reported as (t + PreShift) × Scale + PostShift, and a request for output time T fetches input time (T − PostShift) / Scale − PreShift. Use it to align runs that started at different times, change time units (Scale 0.001 turns milliseconds into seconds), or repeat a cyclic dataset with Periodic. Nothing is resampled; use pvTemporalInterpolator for in-between states.

Common mistakes and assumptions:

  • The upstream description gives the transform as t*Shift + Scale; the native code applies PreShift before scaling and PostShift after it, so the two shifts differ by a factor of Scale.
  • Keep Scale non-zero; the backward conversion divides by it.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalShiftScale. Identity: filters/TemporalShiftScale. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input to the Temporal Shift Scale filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MaximumNumberOfPeriods If Periodic time is enabled, this controls how many time periods time is reported for. A filter cannot output an infinite number of time steps and therefore a finite number of periods is generated when reporting time. {"maximum":100.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
Periodic If Periodic is true, requests for time will be wrapped around so that the source appears to be a periodic time source. If data exists for times {0,N-1}, setting periodic to true will cause time 0 to be produced when time N, 2N, 2N etc is requested. This effectively gives the source the ability to generate time data indefinitely in a loop. When combined with Shift/Scale, the time becomes periodic in the shifted and scaled time frame of reference. Note: Since the input time may not start at zero, the wrapping of time from the end of one period to the start of the next, will subtract the initial time - a source with T{5..6} repeated periodically will have output time {5..6..7..8} etc. {"type":"boolean"} native initialisation / omitted false
PeriodicEndCorrection If Periodic time is enabled, this flag determines if the last time step is the same as the first. If PeriodicEndCorrection is true, then it is assumed that the input data goes from 0-1 (or whatever scaled/shifted actual time) and time 1 is the same as time 0 so that steps will be 0,1,2,3...N,1,2,3...N,1,2,3 where step N is the same as 0 and step 0 is not repeated. When this flag is false the data is assumed to be literal and output is of the form 0,1,2,3...N,0,1,2,3... By default this flag is ON {"type":"boolean"} native initialisation / omitted false
PostShift The amount of time the input is shifted. {"type":"number"} native initialisation / omitted 1
PreShift Apply a translation to the data before scaling. To convert T{5,100} to T{0,1} use Preshift=-5, Scale=1/95, PostShift=0 To convert T{5,105} to T{5,10} use Preshift=-5, Scale=5/100, PostShift=5 {"type":"number"} native initialisation / omitted 1
Scale The factor by which the input time is scaled. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalShiftScale",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalSmoothing#

Replaces each point and cell array value by its plain (unweighted) mean over a sliding window of 2 × TemporalWindowHalfWidth + 1 stored time steps centred on the requested step. The output is still temporal, but loses HalfWidth steps at each end of the series, and requests outside the remaining range use the nearest available step. Use it to suppress step-to-step noise in transient results; the number and order of points and cells must not change over time.

Common mistakes and assumptions:

  • Each output step updates the whole upstream pipeline once per window step, which can be expensive.
  • Time spacing is ignored, so unevenly stored steps are weighted equally.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalSmoothing. Identity: filters/TemporalSmoothing. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Temporal Smoothing filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
TemporalWindowHalfWidth Set the temporal window half width. When requesting a time step, the associated data will be smoothed using this number of time steps before and after it. The resulting window's width is (halfwidth*2)+1 time steps. This property also influences the number of timesteps produced by the filter to exclude time steps where the full window cannot be applied. {"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalSmoothing",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalSnaptoTimeStep#

Makes a request for any time return the data of one of the input's stored time steps: SnapMode picks the nearest stored step (ParaView default), the last step at or below, or the first step at or above the requested time. Data are neither modified nor interpolated. Use it when scene times do not match the saved solver times exactly; use pvTemporalInterpolator to blend between steps instead.

Common mistakes and assumptions:

  • Nearest can serve a requested time from a later stored step; use NextBelowOrEqual when results must never come from the future.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalSnaptoTimeStep. Identity: filters/TemporalSnapToTimeStep. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input of the filter. Accepted data: any data object (vtkDataObject). True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataObject"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
SnapMode Determine which time step to snap to. {"type":"enum","values":["Nearest","NextBelowOrEqual","NextAboveOrEqual"]} native initialisation / omitted "Nearest"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalSnaptoTimeStep",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTemporalStatistics#

Computes, for every point and cell array of a time-dependent input, its average, minimum, maximum and population standard deviation over all input time steps, which the filter requests itself. The output has the input's type and geometry, no time, and arrays named <name>_average, <name>_minimum, <name>_maximum and <name>_stddev (other arrays are not kept). Every step is weighted equally regardless of time spacing, so this is not a time integral. This is the generated binding with native names (ComputeAverage, …); the curated temporalStatistics does the same with shorter option names.

Common mistakes and assumptions:

  • Unequal time steps bias the average; resample time first if the spacing varies.
  • Every time step is read and processed, which can take long on large series; restrict the input time range first.
  • The mesh must keep the same points and cells over time; on changing meshes the statistics are meaningless.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TemporalStatistics. Identity: filters/TemporalStatistics. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Temporal Statistics filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ComputeAverage Compute the average of each point and cell variable over time. {"type":"boolean"} native initialisation / omitted false
ComputeMaximum Compute the maximum of each point and cell variable over time. {"type":"boolean"} native initialisation / omitted false
ComputeMinimum Compute the minimum of each point and cell variable over time. {"type":"boolean"} native initialisation / omitted false
ComputeStandardDeviation Compute the standard deviation of each point and cell variable over time. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTemporalStatistics",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTensorGlyph#

Places a glyph (sphere by ParaView default; cylinder, box or superquadric) at every point and scales and orients it by the eigen-decomposition of the symmetric part of a point tensor: the major eigenvalue scales the glyph's x axis along the major eigenvector, the medium y, the minor z. Tensors may have 9 components or 6 symmetric components ordered XX, YY, ZZ, XY, YZ, XZ. Output is polydata, by default coloured by input scalars. Use it for stress, strain or diffusion tensors; pvGlyph handles vectors.

Common mistakes and assumptions:

  • Six-component tensors must use XX, YY, ZZ, XY, YZ, XZ; other orders (e.g. Voigt XX, YY, ZZ, YZ, XZ, XY) give wrong orientations.
  • Glyph size is ScaleFactor times eigenvalue, so near singularities glyphs explode; enable LimitScalingByEigenvalues with a MaxScaleFactor.
  • ParaView warns that glyphing every point of a structured grid can use much memory; subsample first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TensorGlyph. Identity: filters/TensorGlyph. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Glyph filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point-centred array with 6,9 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColorGlyphs This property determines whether or not to color the glyphs. {"type":"boolean"} native initialisation / omitted false
Colorby This property determines whether input scalars or computed eigenvalues at the point should be used to color the glyphs. If ThreeGlyphs is set and the eigenvalues are chosen for coloring then each glyph is colored by the corresponding eigenvalue and if not set the color corresponding to the largest eigenvalue is chosen. {"type":"enum","values":["input scalars","eigenvalues"]} native initialisation / omitted "input scalars"
ExtractEigenvalues Toggle whether to extract eigenvalues from tensor. If false, eigenvalues/eigenvectors are not extracted and the columns of the tensor are taken as the eigenvectors (the norm of column, always positive, is the eigenvalue). If true, the glyph is scaled and oriented according to eigenvalues and eigenvectors; additionally, eigenvalues are provided as new data array. {"type":"boolean"} native initialisation / omitted false
GlyphType This property determines which type of glyph will be placed at the points in the input dataset. {"type":"typed proxy","choices":["Box","Cylinder","Sphere","Superquadric"]} native initialisation / omitted {"type":"Sphere"}
LimitScalingByEigenvalues This property determines whether scaling of glyphs by ScaleFactor times eigenvalue should be limited. This is useful to prevent uncontrolled scaling near singularities. {"type":"boolean"} native initialisation / omitted false
MaxScaleFactor If scaling by eigenvalues should be limited, this value sets an upper limit for scale factor times eigenvalue. {"type":"number"} native initialisation / omitted 1
Scalars This property indicates the name of the scalar array to use for coloring {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleFactor This property specifies the scale factor to scale every glyph by. {"type":"number"} native initialisation / omitted 1
Symmetric This property determines whether or not to draw a mirror of each glyph. {"type":"boolean"} native initialisation / omitted false
Tensors This property indicates the name of the tensor array on which to operate. The indicated array's eigenvalues and eigenvectors are used for scaling and orienting the glyphs. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ThreeGlyphs Toggle whether to produce three glyphs, each of which oriented along an eigenvector and scaled according to the corresponding eigenvector. {"type":"boolean"} native initialisation / omitted false

Nested GlyphType → Box#

Syntax: {"type":"Box","options":{...}}. Native identity: sources/CubeSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Centre of the box relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.XLength Edge length along the glyph’s local x axis (the axis aligned with the vector or major eigenvector). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.YLength Edge length along the glyph’s local y axis (the medium eigenvector in Tensor Glyph). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.ZLength Edge length along the glyph’s local z axis (the minor eigenvector in Tensor Glyph). {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Nested GlyphType → Cylinder#

Syntax: {"type":"Cylinder","options":{...}}. Native identity: sources/CylinderSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Capping When true, both ends of the cylinder are closed with polygons; when false they are open. {"type":"boolean"} native initialisation / omitted false
GlyphType.options.Center Centre of the cylinder relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Height Length of the cylinder along its local y axis, split equally either side of Center. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Radius Radius of the cylinder’s circular cross-section; with Height it sets how thick each glyph is relative to its length. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.Resolution Number of facets around the cylinder; higher values look rounder but add polygons to every glyph. {"maximum":512,"minimum":2,"type":"integer"} native initialisation / omitted 2

Nested GlyphType → Sphere#

Syntax: {"type":"Sphere","options":{...}}. Native identity: sources/SphereSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Centre of the sphere relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.EndPhi Ending latitude measured from the +z pole; 90 gives the upper hemisphere, 180 the full sphere. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.EndTheta Ending longitude about the local z axis; less than 360 leaves the sphere open. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.PhiResolution Number of divisions in latitude (phi, measured from the +z pole) between StartPhi and EndPhi. {"minimum":3,"type":"integer"} native initialisation / omitted 3
GlyphType.options.Radius Radius of the sphere; the static 0.5 gives a glyph of unit diameter before the operation’s scaling. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.StartPhi Starting latitude measured from the +z pole (0) toward the −z pole (180); values above 0 cut off a cap at the top. {"maximum":180.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.StartTheta Starting longitude, about the local z axis; with EndTheta it lets you draw only a wedge of the sphere. A full sphere uses 0 to 360. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
GlyphType.options.ThetaResolution Number of divisions around the sphere in longitude (theta, about the local z axis) between StartTheta and EndTheta; higher values look rounder but add polygons to every glyph. {"minimum":3,"type":"integer"} native initialisation / omitted 3

Nested GlyphType → Superquadric#

Syntax: {"type":"Superquadric","options":{...}}. Native identity: sources/SuperquadricSource. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
GlyphType.options.Center Centre of the superquadric relative to the glyph’s local origin (the data point). {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.PhiResolution Number of divisions in latitude; VTK rounds it to a multiple of 4. {"maximum":1024,"minimum":4,"type":"integer"} native initialisation / omitted 4
GlyphType.options.PhiRoundness Roundness in the latitudinal (phi) direction: values near 0 give flat, box-like profiles, 1 round ones, and values above 1 pinched profiles. {"minimum":0.01,"type":"number"} native initialisation / omitted 0.01
GlyphType.options.Scale Scale factors [sx, sy, sz] stretching the superquadric along its local axes; normals remain correct under unequal scaling. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
GlyphType.options.Size Isotropic size coefficient of the superquadric. Together with Thickness it sets generation coefficients, so it may not equal the exact outer dimension. {"type":"number"} native initialisation / omitted 1
GlyphType.options.ThetaResolution Number of divisions in longitude; VTK rounds it to a multiple of 8. Higher values look smoother but add polygons to every glyph. {"maximum":1024,"minimum":8,"type":"integer"} native initialisation / omitted 8
GlyphType.options.ThetaRoundness Roundness in the longitudinal (theta) direction: values near 0 give square cross-sections, 1 circular ones, and values above 1 pinched, star-like shapes. {"minimum":0.01,"type":"number"} native initialisation / omitted 0.01
GlyphType.options.Thickness Thickness of the ring when Toroidal is true, from near 0 (thin ring, large hole) to 1 (thick ring, small hole); it does not change the outer radius. Ignored when Toroidal is false. {"maximum":1.0,"minimum":0.0001,"type":"number"} native initialisation / omitted 0.0001
GlyphType.options.Toroidal When true, a toroidal (ring-shaped) superquadric with a hole is generated; when false, a solid, ellipsoid-like one. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTensorGlyph",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTensorPrincipalInvariants#

Computes the principal values and principal directions of selected symmetric tensor arrays (for example stress or strain). For each selected array <name> it adds <name> - Sigma 1, 2 and 3 (values sorted from largest to smallest) and the matching <name> - Sigma n (Vector) direction arrays, keeping the input arrays. Accepted tensors have 6 components in the order XX, YY, ZZ, XY, YZ, XZ, or 3 components named XX, YY, XY for 2-D tensors. Use pvYieldCriteria when you need Tresca or von Mises values.

Common mistakes and assumptions:

  • Full 9-component tensors are not accepted; extract the symmetric 6-component form first.
  • A 3-component array is treated as a 2-D tensor only when its component names are exactly XX, YY and XY; otherwise it is ignored as a vector.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TensorPrincipalInvariants. Identity: filters/TensorPrincipalInvariants. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellTensors Cell tensors from which to compute principal invariants. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointTensors Point tensors from which to compute principal invariants. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ScalePrincipalVectorsWithPrincipalValues Principal vectors can be scaled by the principal values instead of being unitary. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTensorPrincipalInvariants",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTessellate#

Subdivides cells with non-linear geometry or fields (quadratic and higher-order cells) into linear simplices (tetrahedra, triangles or lines up to OutputDimension) until the chord error and optional per-field errors at edge midpoints fall below their limits, giving an unstructured grid that approximates curved geometry and fields with linear pieces. Use it before operations or exports that only handle linear cells; linear input is just split into simplices.

Common mistakes and assumptions:

  • Output size grows quickly with MaximumNumberofSubdivisions, especially with OutputDimension 3.
  • ChordError is in dataset length units; tighten it for small parts.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Tessellate. Identity: filters/TessellatorFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Tessellate filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData); any dataset (meshes, grids, point sets) (vtkDataSet); unstructured grids (vtkUnstructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData","vtkDataSet","vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ChordError This property controls the maximum chord error allowed at any edge midpoint in the output tessellation. The chord error is measured as the distance between the midpoint of any output edge and the original nonlinear geometry. {"type":"number"} native initialisation / omitted 1
FieldError This property controls the maximum field error allowed at any edge midpoint in the output tessellation. The field error is measured as the difference between a field value at the midpoint of an output edge and the value of the corresponding field in the original nonlinear geometry. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]
MaximumNumberofSubdivisions This property specifies the maximum number of times an edge may be subdivided. Increasing this number allows further refinement but can drastically increase the computational and storage requirements, especially when the value of the OutputDimension property is 3. {"maximum":8,"minimum":0,"type":"integer"} native initialisation / omitted 0
MergePoints If the value of this property is set to 1, coincident vertices will be merged after tessellation has occurred. Only geometry is considered during the merge and the first vertex encountered is the one whose point attributes will be used. Any discontinuities in point fields will be lost. On the other hand, many operations, such as streamline generation, require coincident vertices to be merged. Toggle whether to merge coincident vertices. {"type":"boolean"} native initialisation / omitted false
OutputDimension The value of this property sets the maximum dimensionality of the output tessellation. When the value of this property is 3, 3D cells produce tetrahedra, 2D cells produce triangles, and 1D cells produce line segments. When the value is 2, 3D cells will have their boundaries tessellated with triangles. When the value is 1, all cells except points produce line segments. {"maximum":3,"minimum":1,"type":"integer"} native initialisation / omitted 1

onVisit commands:

{
  "ResetFieldCriteria": {
    "command": "ResetFieldCriteria",
    "native": "ResetFieldCriteria"
  }
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTessellate",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

Example command request (pipeline node only): "onVisit":["ResetFieldCriteria"]. Commands run in this authored order before the update.

pvTest3DWidget#

ParaView-internal test proxy: a vtkConeSource exposing only Resolution, with VTK's cone defaults (height 1, radius 0.5, apex along +x, centred at the origin). It exists to test 3-D widgets and has no analysis purpose; use pvCone or the curated cone operation for real cone geometry.

Common mistakes and assumptions:

  • Only the facet count can be changed; size, position and direction are fixed.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Test3DWidget. Identity: sources/Test3DWidget. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Resolution Set the number of faces used to generate the cone. {"maximum":128,"minimum":1,"type":"integer"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTest3DWidget"
}

pvTetrahedralize#

Splits all 3-D cells into tetrahedra and 2-D cells into triangles, producing an unstructured grid; point data are unchanged and cell data are copied to the pieces. Use it when a later step or export needs simplices only. ParaView warns on creation because the cell count can grow several-fold.

Common mistakes and assumptions:

  • A hexahedral mesh becomes several times as many cells; check memory before running on large meshes.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Tetrahedralize. Identity: filters/DataSetTriangleFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Tetrahedralize filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid); curvilinear structured grids (vtkStructuredGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkImageData","vtkRectilinearGrid","vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTetrahedralize",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvText#

Source that produces a one-row, one-column table whose Text column holds the whole Text string as a single cell; the string is not split. ParaView's help describes '|' as a column separator and newlines as rows, but that applies to ParaView's text display of the table, not to the table vtkPVTextSource outputs. Use it for titles, captions or a fixed label; use pvAnnotateTime or pvAnnotateAttributeData for text derived from time or data.

Common mistakes and assumptions:

  • The output table has exactly one cell, so table filters downstream see one string whatever punctuation or line breaks it contains.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Text. Identity: sources/TextSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Text This property specifies the text to display. To display text separated into cells, use newlines to separate text into rows and the '|' (pipe) character to create columns. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvText"
}

pvTextureMaptoCylinder#

Adds 2-D texture coordinates (point array "Texture Coordinates") by projecting each point onto a cylinder: s follows the angle around the axis and t the position along it, 0 at Point1 and 1 at Point2. The axis is fitted automatically from an oriented bounding box (ParaView default) or given by Point1 and Point2. Use it to wrap an image texture around roughly cylindrical geometry such as pipes or vessels; pvTextureMaptoPlane suits flat parts. The geometry and other arrays pass through unchanged.

Common mistakes and assumptions:

  • Texture coordinates only affect rendering with a texture resource; they do not change field values.
  • Points beyond the Point1–Point2 segment get t outside 0 to 1; place the points at the ends of the part.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TextureMaptoCylinder. Identity: filters/TextureMapToCylinder. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Texture Map to Cylinder filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateCylinderAutomatically When set, the filter will try to determine the size and orientation of the cylinder used for texture mapping using data bounds. {"type":"boolean"} native initialisation / omitted false
Point1 When GenerateCylinderAutomatically is not set, specify the first point defining the axis of the cylinder through its center. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 When GenerateCylinderAutomatically is not set, specify the second point defining the axis of the cylinder through its center. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
PreventSeam Control how the texture coordinates are generated. If Prevent Seam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the theta angle variation between 0->180 and 180->0 degrees. Otherwise, the s-coordinate ranges from 0->1 between 0->360 degrees. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTextureMaptoCylinder",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTextureMaptoPlane#

Adds 2-D texture coordinates (point array "Texture Coordinates") by projecting each point onto a plane. In automatic mode (ParaView default, used while Origin and Point1 are both [0, 0, 0]) a least-squares plane is fitted and s and t run from 0 to 1 across the projected bounds. Otherwise s is the projection of (point − Origin) on Point1 − Origin, divided by that edge's squared length, and t likewise with Point2, so s and t are 0 at Origin and 1 at Point1 or Point2. Use it to drape an image (e.g. a photograph or map) on a flat or gently curved surface; pvTextureMaptoCylinder suits round parts.

Common mistakes and assumptions:

  • While Automatic is true the explicit points are used only if Origin or Point1 is non-zero, and Point2 alone is ignored; set Automatic to false whenever you give the points.
  • Automatic mode needs at least three points; smaller inputs get no texture coordinates.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TextureMaptoPlane. Identity: filters/TextureMapToPlane. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Texture Map to Plane filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Automatic If set the plane values will be automatically generated. Note that for this to work all the Origin, Point1 and Point2 must all be set to zero. {"type":"boolean"} native initialisation / omitted false
Origin This property specifies the 3D coordinates for the origin of the plane. Set all to zero if you want to use automatic generation. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point1 This property specifies the 3D coordinates for Point1 of the plane. Set all to zero if you want to use automatic generation. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Point2 This property specifies the 3D coordinates for Point2 of the plane. Set all to zero if you want to use automatic generation. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTextureMaptoPlane",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTextureMaptoSphere#

Adds 2-D texture coordinates (array Texture Coordinates) by projecting each point onto a sphere centred at the mean of the input points: s runs around the z axis, counter-clockwise from +x, and t increases from the north pole towards the south pole, both within 0 to 1. Use it to wrap an image texture, e.g. a map, onto roughly spherical geometry in rendered scenes; geometry and data values are unchanged.

Common mistakes and assumptions:

  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TextureMaptoSphere. Identity: filters/TextureMapToSphere. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Texture Map to Sphere filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
PreventSeam Control how the texture coordinates are generated. If Prevent Seam is set, the s-coordinate ranges from 0->1 and 1->0 corresponding to the theta angle variation between 0->180 and 180->0 degrees. Otherwise, the s-coordinate ranges from 0->1 between 0->360 degrees. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTextureMaptoSphere",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvThreshold#

Extracts the cells whose values of a chosen point or cell array satisfy a criterion (Between LowerThreshold and UpperThreshold, below the lower or above the upper), producing an unstructured grid (or a masked hyper tree grid). It exposes the full native control: component handling for vector arrays (one component, magnitude, All or Any), Invert, AllScalars for point data and a continuous cell range. Use threshold for the common inclusive range test with validated field names; use pvClip with a scalar clip for smooth cuts through cells.

Common mistakes and assumptions:

  • Cells are kept or dropped whole; the boundary is staircase-shaped, not interpolated.
  • With a point array and AllScalars true (ParaView default), a cell is kept only if all its points pass; set AllScalars false to keep cells touching the range.
  • LowerThreshold and UpperThreshold may be initialized from the array range by ParaView; set both explicitly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Threshold. Identity: filters/Threshold. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Threshold filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AllScalars If the value of this property is 1, then a cell is only included in the output if the value of the selected array for all its points is within the threshold. This is only relevant when thresholding by a point-centered array. {"type":"boolean"} native initialisation / omitted false
ComponentMode This property specifies how multi-component arrays are handled. 'Selected' will use the 'Selected Component' property. 'All' will pass if all components satisfy the rule. 'Any' will pass if any component satisfies the rule. {"type":"enum","values":["Selected","All","Any"]} native initialisation / omitted "Selected"
Invert Invert the threshold results. That is, cells that would have been in the output with this option off are excluded, while cells that would have been excluded from the output are included. {"type":"boolean"} native initialisation / omitted false
LowerThreshold The value of this property specifies the lower bound of the thresholding operation. {"type":"number"} native initialisation / omitted 1
MemoryStrategy Select how to construct the result in memory: - MaskInput (default): shallow copy the input and mask all cells being thresholded - Regenerate Trees And Index Fields: generate a new tree structure but use indexed arrays on the input for cell data - New HyperTreeGrid: construct a new HyperTreeGrid from scratch representing the minimal threshold of the input {"type":"enum","values":["Mask Input","Regenerate Trees And Index Fields","New HyperTreeGrid"]} native initialisation / omitted "Mask Input"
Scalars The value of this property contains the name of the array from which to perform thresholding. Be aware that HTG does not support multi-component arrays. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
SelectedComponent This property specifies which component of the array needs to satisfy the rule. {"type":"integer"} native initialisation / omitted 1
ThresholdMethod This property indicates the threshold method. {"type":"enum","values":["Between","Below Lower Threshold","Above Upper Threshold"]} native initialisation / omitted "Between"
UpperThreshold The value of this property specifies the upper bound of the thresholding operation. {"type":"number"} native initialisation / omitted 1
UseContinuousCellRange If off, the vertex scalars are treated as a discrete set. If on, they are treated as a continuous interval over the minimum and maximum. One important "on" use case: When setting lower and upper threshold equal to some value and turning AllScalars off, the results are cells containing the isosurface for that value. WARNING: Whether on or off, for higher order input, the filter will not give accurate results. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvThreshold",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvThresholdSelectionSource#

Creates a threshold selection: elements whose value of ArrayName lies inside any of the [min, max] ranges in Thresholds (inclusive), on cells or points per FieldType. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. Unlike threshold or pvThreshold it does not change the data by itself, so the same selection can be reused, inverted with InsideOut or grown with NumberOfLayers.

Common mistakes and assumptions:

  • ParaView's default ArrayName is "none"; set it to a real array or nothing is selected.
  • For a multi-component array the first component (index 0) is compared, not the magnitude.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ThresholdSelectionSource. Identity: sources/ThresholdSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ArrayName For threshold and value selection, this controls the name of the scalar array that will be thresholded within. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false
Thresholds The list of thresholds that will be added to the selection produced by the selection source. Complete tuples of 2 values. {"items":{"type":"number"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvThresholdSelectionSource"
}

pvThresholdTable#

Keeps the rows of a table (vtkTable) whose value in one numeric column satisfies a threshold: below MaxValue, above MinValue, between them, or outside them. The output is a table with the same columns and the same or fewer rows. Use it to filter CSV data, statistics output or probe tables; use threshold or pvThreshold for meshes.

Common mistakes and assumptions:

  • The column must be a single-component numeric array.
  • MinValue and MaxValue may be initialized by ParaView from the column range; set the ones the chosen Mode uses.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ThresholdTable. Identity: filters/ThresholdTable. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Threshold Table filter. Accepted data: tables (rows and columns) (vtkTable). The input needs at least one point- or cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Column This property specifies which column to use for thresholding. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
MaxValue The value of this property specifies the upper bound of the thresholding operation. {"type":"number"} native initialisation / omitted 1
MinValue The value of this property specifies the lower bound of the thresholding operation. {"type":"number"} native initialisation / omitted 1
Mode This property indicates the threshold method. {"type":"enum","values":["Below Max Threshold","Above Min Threshold","Between","Outside"]} native initialisation / omitted "Below Max Threshold"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvThresholdTable",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTimeSource#

Test source with time: an unstructured grid of one unit voxel cell (or a column of voxels along y that grows and shrinks over time when Growing is on) carrying "Point Value" and "Cell Value" arrays equal to sin(2πt) plus label and coordinate arrays, over the time range 0 to 1 with ten discrete steps. XAmplitude and YAmplitude move the cell along a sine path over time. Use it to check time handling ($time, animation, temporal filters) without a real case.

Common mistakes and assumptions:

  • The native description calls the output a uniform grid; VTK actually produces a vtkUnstructuredGrid.
  • With Analytic false only the ten steps 0, 1/9, …, 1 exist and other requested times snap to the previous step; enable Analytic for continuous values.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: TimeSource. Identity: sources/TimeSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Analytic Makes the time source produce discrete steps of or an analytic sin wave. {"type":"boolean"} native initialisation / omitted false
Growing Makes the time source grow and shrink along Y over time. {"type":"boolean"} native initialisation / omitted false
XAmplitude Controls how far the data set moves along X over time. {"type":"number"} native initialisation / omitted 1
YAmplitude Controls how far the data set moves along Y over time. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTimeSource"
}

pvTimeStepProgressBar#

Produces a one-row, one-column table with a ProgressRate value between 0 and 1 giving the position of the input's current time within its time steps or time range. In ParaView it drives a progress-bar annotation in an animation; in Schemaxis the result is just that table. Any time-dependent input works; the input data are not passed through.

Common mistakes and assumptions:

  • For input without time information the value is 0.
  • This is an annotation helper, not data processing; use pvAnnotateTimeFilter or pvAnnotateTime for a textual time label.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TimeStepProgressBar. Identity: filters/TimeStepProgressFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input dataset for which to display the time step. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTimeStepProgressBar",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTransform#

Applies a translation, rotation and scaling (Transform, ParaView default the Transform3 'Transform' choice, identity until set) to point coordinates. Point-set inputs keep their type; image and rectilinear inputs come out as structured grids. Vectors and normals are rotated with the geometry and, with TransformAllInputVectors (ParaView default true), every other 3-component array too. The curated transform is the simpler alternative.

Common mistakes and assumptions:

  • With TransformAllInputVectors true, 3-component arrays that are not vectors (e.g. RGB colours or principal values) are rotated as well; turn it off in that case.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Transform. Identity: filters/TransformFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Transform filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Transform The values in this property allow you to specify the transform (translation, rotation, and scaling) to apply to the input dataset. {"type":"typed proxy","choices":["GeoTransform","RotateAroundOriginTransform","Transform"]} native initialisation / omitted {"type":"Transform"}
TransformAllInputVectors If off, only Vectors and Normals will be transformed. If on, all three-component data arrays (considered as 3D vectors) will be transformed. All other arrays won't be flipped and will only be copied. {"type":"boolean"} native initialisation / omitted false

Nested Transform → GeoTransform#

Syntax: {"type":"GeoTransform","options":{...}}. Native identity: transforms/GeoTransform. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Transform.options.DestinationProjection PROJ definition of the output coordinates, e.g. “+proj=utm +zone=33 +datum=WGS84” for UTM eastings and northings in metres, or “+proj=cart +datum=WGS84” for geocentric x, y, z. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Transform.options.SourceProjection PROJ definition of the coordinates the input points are in, e.g. “+proj=longlat +datum=WGS84” for longitude and latitude in degrees (x = longitude, y = latitude). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Transform.options.TransformZCoordinate When true, x, y and z are converted together through PROJ’s CRS-to-CRS transformation (needed for 3D conversions such as geographic to geocentric); when false, only x and y are converted and z is left unchanged, which suits elevations kept in their own units. {"type":"boolean"} native initialisation / omitted false

Nested Transform → RotateAroundOriginTransform#

Syntax: {"type":"RotateAroundOriginTransform","options":{...}}. Native identity: extended_sources/RotateAroundOriginTransform. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Transform.options.Originofrotation Pivot point [x, y, z] that stays fixed while the dataset rotates around it. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Transform.options.Rotate Rotation angles [rx, ry, rz] about axes through OriginOfRotation parallel to x, y and z, combined in VTK’s Z-X-Y convention (the matrix is RotateZ · RotateX · RotateY); for a rotation about a single axis the order does not matter. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Nested Transform → Transform#

Syntax: {"type":"Transform","options":{...}}. Native identity: extended_sources/Transform3. Omitted nested options retain native values on subsequent visits.

Key Meaning / native assignment Type and constraints Default / required Example value
Transform.options.Rotate Rotation angles [rx, ry, rz] about the x, y and z axes through the coordinate origin, combined in VTK’s Z-X-Y convention (the matrix is RotateZ · RotateX · RotateY); for a rotation about a single axis the order does not matter. Applied after Scale and before Translate. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Transform.options.Scale Scale factors [sx, sy, sz] along x, y and z about the coordinate origin, applied first. Values above 1 enlarge, below 1 shrink, and negative values mirror the geometry. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Transform.options.Translate Displacement [tx, ty, tz] added to every point after scaling and rotation. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTransform",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTransposeTable#

Builds a sub-table from selected columns of a table and, by default, transposes it so that each selected column becomes a row; a first column holding the original column names is added by default. With Onlyextractselectedcolumns it skips the transposition and simply returns the selected columns. Use it to reshape statistics or probe tables for plotting or export.

Common mistakes and assumptions:

  • Only the listed columns are kept; with no selection the output is empty.
  • Transposing mixes columns of different types into rows; check the output column types before numeric processing.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TransposeTable. Identity: filters/TransposeTable. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: tables (rows and columns) (vtkTable). The input needs at least one row (table) array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Addacolumnwithoriginalcolumnsname This flag indicates if a column must be inserted at index 0 with the names (ids) of the input columns. {"type":"boolean"} native initialisation / omitted false
Onlyextractselectedcolumns This flag indicates if the sub-table must be effectively transposed or not. {"type":"boolean"} native initialisation / omitted false
Usethecolumnwithoriginalcolumnsname This flag indicates if the output column must be named using the names listed in the index 0 column. {"type":"boolean"} native initialisation / omitted false
VariablesofInterest Choose arrays whose entries will be used to form observations for statistical analysis. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTransposeTable",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTriangleStrips#

Joins triangles into triangle strips and line segments into polylines (vtkStripper), giving more compact polydata with the same geometry. Other polygons and existing strips or polylines pass through, and cell data is discarded because the cells change. Its main use in workflows is joining separate segments into polylines (JoinContiguousSegments), e.g. contour or slice lines before pvDecimatePolyline, pvPolylineLength or tube.

Common mistakes and assumptions:

  • Cell arrays are lost; convert them to point data first if needed.
  • Only triangles are stripped; triangulate general polygons first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TriangleStrips. Identity: filters/Stripper. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Triangle Strips filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
JoinContiguousSegments Connect contiguous lines into one polyline. Defaults to off. {"type":"boolean"} native initialisation / omitted false
MaximumLength This property specifies the maximum number of triangles/lines to include in a triangle strip or polyline. {"maximum":100000,"minimum":4,"type":"integer"} native initialisation / omitted 4

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTriangleStrips",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTriangulate#

Converts polygonal data to triangles, lines and vertices only: polygons are triangulated, triangle strips split into triangles and polylines into single segments (vtkTriangleFilter). The output stays polydata with the same points. Use it before operations that need triangles, such as decimate, pvDecimate or pvSurfaceTangents, or before triangle-only exports; triangulate is the curated equivalent and pvTetrahedralize handles volume cells.

Common mistakes and assumptions:

  • Concave or non-planar polygons can triangulate poorly; inspect the result on such input.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Triangulate. Identity: filters/TriangleFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Triangulate filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTriangulate",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvTrivialProducer#

Wraps an already-existing VTK data object so it can feed a pipeline (vtkTrivialProducer). The data must be attached by native code (SetOutput); authored Schemaxis input cannot do that, so in a workflow this source has nothing to produce. Schemaxis uses the class internally in its writer qualification tool, not as an authoring operation. Use a reader or a source operation for real data.

Common mistakes and assumptions:

  • Schemaxis has no authored way to hand a dataset to a trivial producer, so the node is expected to produce an empty output; this has not been run.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: TrivialProducer. Identity: sources/TrivialProducer. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTrivialProducer"
}

pvTube#

Wraps every line or polyline of polygonal input in a tube of NumberofSides faces (ParaView default 6) and Radius, producing polydata surfaces. VaryRadius can make the radius follow a point scalar or vector array, up to RadiusFactor times Radius. The cross-section is oriented by the input's point Normals array, by normals generated along each line, or by DefaultNormal when UseDefaultNormal is true. Use it to render streamlines, particle paths or wire models in 3-D; tube is the curated version.

Common mistakes and assumptions:

  • Duplicate consecutive points, or normals parallel to the line, make VTK skip that line; run clean first.
  • Radius is in dataset units and ParaView may initialize it from the input extent (1 %); set it explicitly.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: Tube. Identity: filters/TubeFilter. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Tube filter. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Capping If this property is set to 1, endcaps will be drawn on the tube. Otherwise the ends of the tube will be open. {"type":"boolean"} native initialisation / omitted false
DefaultNormal Fixed direction [x, y, z] used as the normal at every line point to orient the tube cross-section, applied only when UseDefaultNormal is true. Otherwise VTK uses the input's point Normals array if present, or generates sliding normals along each line; the Vectors array never orients the tube. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
NumberofSides The value of this property indicates the number of faces around the circumference of the tube. {"minimum":3,"type":"integer"} native initialisation / omitted 3
Radius The value of this property sets the radius of the tube. If the radius is varying (VaryRadius property), then this value is the minimum radius. {"type":"number"} native initialisation / omitted 1
RadiusFactor If varying the radius (VaryRadius property), the property sets the maximum tube radius in terms of a multiple of the minimum radius. If not varying the radius, this value has no effect. {"type":"number"} native initialisation / omitted 1
Scalars This property indicates the name of the scalar array on which to operate. The indicated array may be used for scaling the tubes. (See the VaryRadius property.) {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
UseDefaultNormal When true, every point uses DefaultNormal to orient the tube cross-section, ignoring any point Normals array. When false, VTK uses the input's point Normals if present and otherwise generates sliding normals along each polyline. {"type":"boolean"} native initialisation / omitted false
VaryRadius The property determines whether/how to vary the radius of the tube. If varying by scalar, the tube radius linearly varies w.r.t point-based scalar values in the dataset. If the radius varies by vector, a mass flux preserving variation is used. If it varies by absolute scalar, the radius is equal to the scalar field (which thus must be positive!). If it varies by vector norm, the vector magnitude is used in varying the radius. {"type":"enum","values":["Off","By Scalar","By Vector","By Absolute Scalar","By Vector Norm"]} native initialisation / omitted "Off"
Vectors Point vector array, as [association, name] e.g. ["POINTS", "U"], used only to vary the radius when VaryRadius is By Vector or By Vector Norm. Despite the upstream description, VTK's tube filter does not orient tubes by this array. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvTube",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvUnstructuredCellTypes#

Generates an unstructured grid made of one chosen cell type (linear, quadratic, Lagrange or Bezier lines, triangles, quads, tetrahedra, hexahedra, wedges, pyramids, polyhedra…) by filling a BlocksDimensions grid of unit blocks starting at the origin; one block may hold several cells (e.g. six pyramids). Point arrays "DistanceToCenter" and "Polynomial" give known fields. Use it to test how filters, writers or renderers handle a specific cell type or element order.

Common mistakes and assumptions:

  • Lagrange tetrahedral meshes are not always conformal at block boundaries, as the native documentation warns.
  • 1-D types use only the first blocks dimension and 2-D types the first two.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: UnstructuredCellTypes. Identity: sources/UnstructuredCellTypes. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Addnodestocompletepolynomialbasis When true, some quadratic Lagrange cell types will have additional nodes. Specifically, triangles will have 7 points instead of 6; tetrahedra will have 15 points instead of 10; and wedges will have 21 points instead of 18. These additional points increase the number of polynomial terms in each element so that the shape functions can span a larger space of polynomial functions. {"type":"boolean"} native initialisation / omitted false
BlocksDimensions Sets the number of blocks of cells in each direction. A cell block may be divided into multiple cells (e.g. there will be 6 pyramid cells in a cell block). If a 1D cell type is chosen only the first blocks dimension will be used. If a 2D cell type is chosen the first and second blocks dimensions will be used. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
CellOrder This property specifies the interpolation order for Lagrange cell types. {"maximum":10,"minimum":1,"type":"integer"} native initialisation / omitted 1
CellType This property specifies the type of cells to generate. {"type":"enum","values":["Line","Quadratic Line","Cubic Line","Triangle","Quad","Pixel","Polygon","Quadratic Triangle","Quadratic Quad","Bi-Quadratic Quad","Tet","Hex","Polyhedron","Voxel","Wedge","Pyramid","Quadratic Tet","Quadratic Hex","Tri-Quadratic Hexahedron","Quadratic Wedge","Quadratic Pyramid","Tri-Quadratic Pyramid","Lagrange Curve","Lagrange Triangle","Lagrange Quadrilateral","Lagrange Tetrahedron","Lagrange Hexahedron","Lagrange Wedge","Bezier Curve","Bezier Triangle","Bezier Quadrilateral","Bezier Tetrahedron","Bezier Hexahedron","Bezier Wedge"]} native initialisation / omitted "Line"
OutputPrecision This property specifies the precision of point locations and fields. {"type":"enum","values":["Single","Double"]} native initialisation / omitted "Single"
PolynomialFieldOrder This property specifies the order for the "Polynomial" point data field. {"minimum":0,"type":"integer"} native initialisation / omitted 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvUnstructuredCellTypes"
}

pvUnstructuredNetCDFPOPreader#

Reads Parallel Ocean Program (POP) NetCDF output (.pop.nc, .pop.ncdf) and converts its logically structured grid into an unstructured grid on a sphere: horizontal positions come from a companion GRID.nc file in the same folder, and each layer's depth_t is subtracted from an Earth radius of 6371000 (metres), so deeper layers lie closer to the sphere's centre. Stride subsamples and VOI crops the structured index space before conversion. Use pvNetCDFPOPreader for the structured form.

Common mistakes and assumptions:

  • The GRID.nc file must sit beside the data file; without it the lat-lon mapping fails.
  • VerticalVelocity is computed only for a vector grid read over the full depth range with k stride 1.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: UnstructuredNetCDFPOPreader. Identity: sources/UnstructuredPOPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Stride This property indicate the number of indices per dimension (i,j,k) to skip between each point included in this output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
VOI Index box [imin, imax, jmin, jmax, kmin, kmax] of the structured POP grid to read, counted after Stride is applied (zero-based, inclusive). It is applied only when at least one maximum is not -1; a bound outside the data is ignored. Use it to read a region of a large ocean grid. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
VerticalVelocity If there is a velocity vector with only 2 components, specify that the reader should compute the third component. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvUnstructuredNetCDFPOPreader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVASPAnimationReader#

Reads a VASP molecular-dynamics animation file (NPT_Z_ANIMATE.out) into a time-varying vtkMolecule, one frame of atom positions per time step. Use it to animate or analyse trajectories from VASP runs; pvVASPTessellationReader reads the matching Voronoi tessellation file. vtkMolecule output needs pvMoleculeToLines before ordinary dataset filters.

Common mistakes and assumptions:

  • ParaView registers the generic .out extension for this reader; make sure the file really is an NPT_Z_ANIMATE.out file.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: VASPAnimationReader. Identity: sources/VASPAnimationReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The name of the file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVASPAnimationReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVASPTessellationReader#

Reads a VASP NPT_Z_TESSELLATE.out file. Output port 0 is the molecule (vtkMolecule) and port 1 the Voronoi tessellation of the atoms as an unstructured grid, one cell per atom, for each time step. Select port 1 with {"node": id, "port": 1} to measure or render Voronoi cells. Use pvVASPAnimationReader for the trajectory alone.

Common mistakes and assumptions:

  • Port 0 is a vtkMolecule; dataset filters need port 1 or pvMoleculeToLines.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: VASPTessellationReader. Identity: sources/VASPTessellationReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The name of the file to load. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVASPTessellationReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVPICReader#

Reads VPIC kinetic plasma particle-in-cell output through its ASCII .vpc file, which describes the per-processor data files, grid size and time steps. Field and hydro quantities are assembled into one uniform image (vtkImageData) of point arrays. Stride subsamples the grid, and XExtent, YExtent and ZExtent restrict which simulation files (the per-processor tiling of the domain) are read, so a subregion can be viewed at full resolution. This is a distributed reader.

Common mistakes and assumptions:

  • Extents count files of the simulation decomposition, not grid cells or physical coordinates.
  • Large runs can exceed memory; start with a Stride above 1 or narrower extents.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: VPICReader. Identity: sources/VPICReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName ASCII .vpc file describes locations of data files, grid sizes, time step sizes and type and order of data written to the files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays Variables written to the data files are described in the .vpc file and are presented for selection. Only selected variables are loaded for a time step. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Stride VPIC data may be very large and not all is needed for effective visualization. Setting the stride selects every nth data item within the files for display. {"items":{"minimum":1,"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
XExtent VPIC data is written one file per simulation processor. This coarse map of files is used in partitioning files between visualizing processors so that each ParaView processor has its own set of files to display. Ghost cell overlap is handled within the reader. To limit the View of VPIC information the extent in the X dimension of "files" can be specified. Only the files selected will be displayed and they will be partitioned between the visualizing processors, allowing a higher resolution over a smaller area. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
YExtent VPIC data is written one file per simulation processor. This coarse map of files is used in partitioning files between visualizing processors so that each ParaView processor has its own set of files to display. Ghost cell overlap is handled within the reader. To limit the View of VPIC information the extent in the Y dimension of "files" can be specified. Only the files selected will be displayed and they will be partitioned between the visualizing processors, allowing a higher resolution over a smaller area. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]
ZExtent VPIC data is written one file per simulation processor. This coarse map of files is used in partitioning files between visualizing processors so that each ParaView processor has its own set of files to display. Ghost cell overlap is handled within the reader. To limit the View of VPIC information the extent in the Z dimension of "files" can be specified. Only the files selected will be displayed and they will be partitioned between the visualizing processors, allowing a higher resolution over a smaller area. {"items":{"type":"integer"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVPICReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVRMLReader#

Reads the geometry of a VRML 2.0 scene (.wrl, .vrml) through VTK's VRML importer: shapes become polygonal data that, by default, are appended into one block of a multiblock output with a colour array; lights, cameras and textures are dropped. Use it to bring VRML exports from CAD or visualization tools into a pipeline as surfaces.

Common mistakes and assumptions:

  • VRML has no physical unit; check the scale against your other data before combining them.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: VRMLReader. Identity: sources/vrmlreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the VRML reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVRMLReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVTKHDFReader#

Reads VTK's HDF5-based VTKHDF format (.vtkhdf, .hdf): image data, polydata, unstructured grids, overlapping AMR, hyper-tree grids, partitioned collections and multiblock data, including transient data stored in one file. MergeParts (ParaView default true) merges partitioned pieces into one dataset. Several files in FileName form a time series. Choose it for large VTK data written by vtkHDFWriter or simulation codes; use the XML readers (pvXMLUnstructuredGridReader and others) for .vtu/.vtp-style files.

Common mistakes and assumptions:

  • All files in a series must store the same data type.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: VTKHDFReader. Identity: sources/HDFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Select the cell arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTKHDF data format storing the same data type. The standard extension is .vtkhdf. If more than one file is specified, the reader will switch to file series mode and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaximumLevelsToReadByDefaultForAMR The number of levels that the reader can read when the data type is AMR. Set this to 0 to imply no limit. Default is 0. {"type":"integer"} native initialisation / omitted 1
MergeParts Make the reader merge parts in the input data set. If false, the reader will output a partitioned data set. {"type":"boolean"} native initialisation / omitted false
PointArrayStatus Select the point arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseCache Enable the internal reader cache allowing to not re-read data from previous time step if possible. Best used with MergeParts disabled for memory efficiency. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVTKHDFReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvValidateCells#

Checks every cell for defects that break other filters and adds a cell array ValidityState: 0 for a valid cell, otherwise a bit field of problems such as wrong number of points, intersecting edges or faces, non-contiguous edges, non-convexity, or wrongly oriented faces. Geometry and arrays pass through. Use it to diagnose meshes that fail in clipping, integration or export, then threshold on ValidityState to locate bad cells.

Common mistakes and assumptions:

  • Non-convex cells are flagged even though many meshes (e.g. polyhedral CFD meshes) use them legitimately; interpret flags per cell type.
  • The geometric tolerance is VTK's default (not exposed in ParaView); very small cells can be misjudged.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ValidateCells. Identity: filters/ValidateCells. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Cell Validation filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvValidateCells",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvValueSelectionSource#

Creates a value selection: elements whose value of ArrayName equals one of the listed integer values, e.g. all cells with MaterialId 3 or 7. The output is a vtkSelection (no geometry) for the Selection port of pvExtractSelection or pvAnnotateSelection. ParaView documents that it cannot select within composite datasets. Use pvThresholdSelectionSource for value ranges or floating-point data.

Common mistakes and assumptions:

  • The values are stored as vtkIdType integers and VTK's value selector only compares arrays of the same value type, so 32-bit integer or floating-point arrays may match nothing (VTK warns of a type mismatch); check the result, or use pvThresholdSelectionSource with narrow ranges.
  • FieldType defaults to CELL; set POINT when the IDs or values refer to points, otherwise the wrong elements are matched.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: ValueSelectionSource. Identity: sources/ValueSelectionSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ArrayName Name of the array (in the point or cell data, per FieldType) whose values are compared with Values. If it is left empty, VTK falls back to the input's active scalars of that association. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ContainingCells When field type is POINT, this controls whether single vertex cells will be produced for each selected point, or whether the cells that contain each selected point will be produced. When field type is CELL this has no effect. {"type":"boolean"} native initialisation / omitted false
FieldType The location of the array the selection came from (e.g. point, cell). {"type":"enum","values":["CELL","POINT","FIELD","VERTEX","EDGE","ROW"]} native initialisation / omitted "CELL"
InsideOut When this property is false the selection describes everything that should be extracted. When this is true the selection describes everything that should NOT be extracted. {"type":"boolean"} native initialisation / omitted false
NumberOfLayers Specify the number of layers of connected elements to include in the selection. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RemoveIntermediateLayers When using NumberOfLayers, this controls if intermediate layers are removes or not. Default is false. {"type":"boolean"} native initialisation / omitted false
RemoveSeed When using NumberOfLayers, this controls if the initial seed selection is remove or not. Default is false. {"type":"boolean"} native initialisation / omitted false
Values The list of Values that will be added to the selection produced by the selection source. This takes pairs of values as (process number, value). Complete tuples of 2 values. {"items":{"type":"integer"},"type":"array"} native initialisation / omitted [1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvValueSelectionSource"
}

pvVelodyneAMRReader#

Reads Velodyne AMR files (.xamr) into an overlapping AMR dataset: nested refinement levels of uniform blocks with cell-centred variables. Level sets the finest level loaded, counted from the root level 0 (ParaView default 15, which in practice loads all levels of most files), and every variable starts disabled, so name the ones you need in CellArrayStatus. Several files form a time series. pvVisItVelodyneReader is the VisIt-based alternative for Velodyne data.

Common mistakes and assumptions:

  • Without CellArrayStatus the blocks arrive without fields.
  • Loading every level can be memory-intensive; lower Level for an overview.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: VelodyneAMRReader. Identity: sources/VelodyneAMRReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred variables to load from the Velodyne XAMR file, such as density or pressure fields. Listing names loads exactly those arrays and disables every other array the file offers; an empty list loads none. Fewer arrays mean less memory and faster reads. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EnableCaching Keep AMR blocks that have already been read in memory, so later updates that change the level or array selection, or revisit a time, do not reread them from disk. It does not change the data produced. {"type":"boolean"} native initialisation / omitted false
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
Level This property specifies the desired level of resolution that will be visible. {"type":"integer"} native initialisation / omitted 1
PointArrayStatus Names of point-centred arrays to load. This reader lists only cell-centred variables from the file (its array setup registers cell arrays only), so there is normally nothing to select here; use CellArrayStatus and convert with cellToPoint if you need point data. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVelodyneAMRReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItANSYSReader#

Reads an ASCII ANSYS input deck (.inp) through VisIt's ANSYS plugin: the nodes and elements in its NBLOCK and EBLOCK blocks become one unstructured-grid block named "mesh". The plugin defines no variables or materials, so the result is geometry only. ParaView 5.13.3 has no native reader for ANSYS input decks in the Schemaxis catalogue. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Only the mesh is read; ANSYS result files and loads or boundary conditions in the deck are not converted, so do not expect solution arrays.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItANSYSReader. Identity: sources/VisItANSYSReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ANSYS input data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ANSYS input plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ANSYS input plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ANSYS input meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The ANSYS plugin reports a single unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ANSYS input data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ANSYS input plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItANSYSReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItAUXFileReader#

Reads an ASCII .aux fluence file through VisIt's AUXFile plugin: the output is a 2-D rectilinear grid named "mesh" carrying one point array, "fluence". The format is documented only by the plugin source; choose this reader only for files written in that layout. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Many unrelated programs write .aux files (for example LaTeX); this plugin understands only its own fluence layout, so check that the output has the expected grid.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItAUXFileReader. Identity: sources/VisItAUXFileReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from AUXFile data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The AUXFile plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The AUXFile plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the AUXFile meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The AUXFile plugin reports one 2-D rectilinear mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from AUXFile data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For AUXFile data these are one node-centred variable, "fluence". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItAUXFileReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItBOVReader#

Reads VisIt's BOV (brick of values) format: a short text header (.bov) giving DATA_FILE, DATA_SIZE, DATA_FORMAT, BRICK_ORIGIN, BRICK_SIZE, VARIABLE and CENTERING for one raw binary array on a regular grid. The output is a rectilinear-grid block named "mesh" carrying that one variable. Use pvImageReader instead for raw volumes without a BOV header, where you supply dimensions, spacing and data type yourself. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Whether the variable appears in PointArrayStatus or CellArrayStatus depends on the header's CENTERING (NODAL or ZONAL); select it in the matching list.
  • Multi-component data arrive as one vector array; VisIt's real/imaginary expressions are not converted by the bridge.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItBOVReader. Identity: sources/VisItBOVReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from BOV data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The BOV plugin offers the one variable named by VARIABLE in the header; CENTERING NODAL makes it a point array and ZONAL a cell array; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The BOV plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the BOV meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The BOV plugin reports one rectilinear mesh named "mesh"; with DIVIDE_BRICK its bricklets become separate domains of that block. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from BOV data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The BOV plugin offers the one variable named by VARIABLE in the header; CENTERING NODAL makes it a point array and ZONAL a cell array; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItBOVReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItCEAucdReader#

Reads the CEA (French Alternative Energies and Atomic Energy Commission) variant of AVS UCD (.ucd, .inp), where a case is split into per-domain UCD files plus a root file holding time, cycle and material names. The output is one unstructured mesh named "mesh" with one domain per file, point and cell arrays from the files and optional material volume fractions. For ordinary single-file AVS UCD data use the native pvAVSUCDReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Moving one file away from its directory breaks the domain and root-file lookup; copy whole cases.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItCEAucdReader. Identity: sources/VisItCEAucdReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from CEA UCD data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CEA UCD plugin offers the point and cell arrays found in the UCD files; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The CEA UCD plugin offers the material names stored in the CEA root file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the CEA UCD meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CEA UCD plugin reports one unstructured mesh named "mesh" whose domains are the per-domain UCD files of the case. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from CEA UCD data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CEA UCD plugin offers the point and cell arrays found in the UCD files; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItCEAucdReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItCMATReader#

Reads ASCII output of the CMAT Fortran simulation code (.cmat): a 2-D rectilinear mesh named "Mesh" with one cell-centred variable "M". Neither ParaView nor VisIt documents the code further; choose this reader only for CMAT output. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The grid is 2-D (z = 0); operations that need a volume, such as streamline tracing in 3-D, do not apply.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItCMATReader. Identity: sources/VisItCMATReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from CMAT data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For CMAT data these are one cell variable, "M". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The CMAT plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the CMAT meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CMAT plugin reports one 2-D rectilinear mesh named "Mesh" (capital M), possibly split into several domains. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from CMAT data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CMAT plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItCMATReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItCTRLReader#

Reads the control (ctrl) input file of the TB-LMTO (tight-binding linear muffin-tin orbital) electronic-structure code: the atom sites become a point mesh named "mesh" with a point array "element". VisIt's element-name labels and unit-cell metadata are not converted by the bridge, so the result is a point cloud of sites, not a molecule with bonds. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Convert or glyph the points yourself; no bonds or unit-cell box are produced.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItCTRLReader. Identity: sources/VisItCTRLReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from TB-LMTO ctrl data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The TB-LMTO ctrl plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The TB-LMTO ctrl plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the TB-LMTO ctrl meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CTRL plugin reports one point mesh named "mesh" holding the atom sites. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from TB-LMTO ctrl data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For TB-LMTO ctrl data these are one node-centred variable, "element" (the element of each atom site). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItCTRLReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItChomboReader#

Reads HDF5 plotfiles from the Chombo block-structured adaptive mesh refinement framework (LBNL). With only the AMR mesh selected the output is vtkOverlappingAMR (patches on refinement levels); with other meshes selected it is a multiblock dataset. ParaView 5.13.3 has no native Chombo reader; AMReX/BoxLib plotfiles should use pvAMReXBoxLibGridReader instead. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • AMR output suits AMR-aware operations; use pvConvertAMRdatasettoMultiblock or merge before operations that need ordinary datasets, and remember coarse cells under finer patches overlap them.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItChomboReader. Identity: sources/VisItChomboReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Chombo data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Chombo plugin offers the solution components stored in the HDF5 file (normally cell-centred); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Chombo plugin offers material volume fractions when the file provides them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Chombo meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Chombo plugin reports the AMR mesh "Mesh" (patches grouped by refinement level) and, when present, particle meshes. Selecting only the AMR mesh makes the bridge output a vtkOverlappingAMR dataset; otherwise each selected mesh becomes a multiblock child. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Chombo data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Chombo plugin offers the solution components stored in the HDF5 file (normally cell-centred); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItChomboReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItClawReader#

Reads Clawpack/AMRClaw ASCII output through a small .claw boot file whose DIR=, TIME_FILES_SCANF/REGEX and GRID_FILES_SCANF/REGEX (and optional CYCLE_REGEX) lines locate the time-header and grid-data files. The output is a multiblock dataset in which "claw_mesh" holds every grid of every refinement level, with cell-centred solution components. The captured ParaView summary ("a material-ordered format very similar to IOUT=1") does not describe what the plugin source reads. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Write the .claw boot file yourself; pointing FileName at a fort.* data file does not work.
  • The VisIt bridge builds this reader only on non-Windows platforms, so it is missing from Windows ParaView installations.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItClawReader. Identity: sources/VisItClawReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Clawpack data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Clawpack data these are the solution components (q) of the Clawpack output, cell-centred. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Clawpack file to read (.claw); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the .claw boot file (DIR=, TIME_FILES_SCANF/REGEX, GRID_FILES_SCANF/REGEX lines), not a Clawpack data file. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Clawpack plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Clawpack meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Claw plugin reports one AMR mesh named "claw_mesh"; the bridge places its grids, grouped by level, inside a multiblock child rather than an AMR dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Clawpack data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Clawpack plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItClawReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItCurve2DReader#

Intended for VisIt's ASCII curve format (.curve, .ultra, .ult, .u): named x-y curves, one pair per line. The plugin describes these as VisIt curves, but the bridge converts only meshes listed in the plugin metadata (vtkAvtFileFormatAlgorithm), so the output is probably an empty multiblock; this has not been verified. For x-y columns prefer pvCSVReader, then pvTableToPoints or a table plot. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Expect no geometry until a native check shows otherwise; use pvCSVReader for curve data.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItCurve2DReader. Identity: sources/VisItCurve2DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Curve2D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Curve2D plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Curve2D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Curve2D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Curve2D plugin publishes its curves as VisIt curve objects, not meshes, so the bridge may list no meshes here. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Curve2D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Curve2D plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItCurve2DReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItDDCMDReader#

Reads particle and atom snapshot files from ddcMD, LLNL's domain-decomposition molecular dynamics code. Particle files become a point mesh with per-particle fields (species, type, group and the recorded quantities); cgrid files become a rectilinear grid. ParaView 5.13.3 has no native ddcMD reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Particle fields may be declared point- or cell-centred by the plugin; check both selection lists against the reader's available names.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItDDCMDReader. Identity: sources/VisItDDCMDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ddcMD data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ddcMD plugin offers per-particle fields such as "species", "type" and "group" (node-centred), or grid fields for cgrid files; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ddcMD plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ddcMD meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The ddcMD plugin reports a point mesh of particles, or a rectilinear mesh named "quadmesh" for ddcMD cgrid files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ddcMD data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ddcMD plugin offers per-particle fields such as "species", "type" and "group" (node-centred), or grid fields for cgrid files; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItDDCMDReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItDyna3DReader#

Reads DYNA3D input decks (.dyn) for LLNL's explicit finite-element structural code: control, material, node and element cards become one unstructured mesh named "mesh" with material volume fractions and per-element material properties (density, strength, plastic strain, material number). It reads model input, not results; LS-DYNA d3plot result databases need pvLSDynaReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Material properties are inputs from the deck, not computed results.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItDyna3DReader. Identity: sources/VisItDyna3DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from DYNA3D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The DYNA3D plugin offers cell variables "density" (g/cc), "strength", "equivalentPlasticStrain" and "matno", and the point vector "velocity" when the deck gives one; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The DYNA3D plugin offers the material names from the deck's material cards (material set "material"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the DYNA3D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The DYNA3D plugin reports one unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from DYNA3D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The DYNA3D plugin offers cell variables "density" (g/cc), "strength", "equivalentPlasticStrain" and "matno", and the point vector "velocity" when the deck gives one; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItDyna3DReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItExtrudedVolReader#

Reads VisIt's ExtrudedVol format: a text header (.exvol) naming a file stem, a chunk count, a time count and variables, with connectivity and variable files per chunk. The output is an unstructured mesh named "wedge_mesh" with node-centred variables. VisIt itself can write this format; ParaView has no other reader for it. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Missing .exvol_conn or .exvol_var companions make the read fail; copy them with the header.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItExtrudedVolReader. Identity: sources/VisItExtrudedVolReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ExtrudedVol data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ExtrudedVol plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ExtrudedVol plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ExtrudedVol meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The ExtrudedVol plugin reports one unstructured mesh named "wedge_mesh", split into NUMCHUNKS domains. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ExtrudedVol data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For ExtrudedVol data these are the node-centred variables listed on the header's VARIABLES line. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItExtrudedVolReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItFLASHReader#

Reads HDF5 checkpoint and plot files of the FLASH multiphysics AMR code. With only "amr_mesh" selected the output is vtkOverlappingAMR; adding particles or diagnostic meshes gives a multiblock dataset. The native pvFlashReader (hierarchical-box AMR) and pvFLASHAMRParticlesReader are the usual choice; use this reader to cross-check them or to get the AMR blocks and particles from one node. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The diagnostic meshes are for inspecting the block layout, not physics; leave them unselected.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItFLASHReader. Identity: sources/VisItFLASHReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from FLASH data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FLASH plugin offers the FLASH unknowns (cell-centred on the AMR mesh) and particle properties (on the particle mesh); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The FLASH plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the FLASH meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The FLASH plugin reports the block-structured AMR mesh "amr_mesh", a "particles" point mesh when particles are stored, and diagnostic meshes (for example Morton-curve and block/processor meshes). Selecting only the AMR mesh gives vtkOverlappingAMR output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from FLASH data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FLASH plugin offers the FLASH unknowns (cell-centred on the AMR mesh) and particle properties (on the particle mesh); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItFLASHReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItFluentReader#

Reads a legacy ANSYS Fluent case file (.cas) together with the .dat data file of the same name: the mesh becomes one unstructured block named "Mesh" with cell-centred solution fields. The native pvFluentCaseReader (legacy .cas/.dat, distributed) and pvFluentCFFCaseReader (.cas.h5/.dat.h5) are normally preferable; this reader is a cross-check when the native reader rejects a file. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Fields are cell-centred; apply cellToPoint before operations that need point data.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItFluentReader. Identity: sources/VisItFluentReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Fluent data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Fluent data these are the cell-centred solution fields stored in the matching .dat file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Fluent plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Fluent meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Fluent plugin reports one unstructured mesh named "Mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Fluent data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Fluent plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItFluentReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItGGCMReader#

Reads output of the (Open)GGCM Geospace General Circulation Model of the magnetosphere (.3df and .mer files; the plugin derives the companion grid-file name from the data-file name). The output is a rectilinear grid named "GGCM mesh" with node-centred fields. ParaView 5.13.3 has no native GGCM reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The companion grid file must be present next to the data file under the name the plugin derives.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItGGCMReader. Identity: sources/VisItGGCMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from GGCM data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The GGCM plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single GGCM file to read (.3df, .mer); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). The plugin derives the companion grid-file name from this name, so keep both files together. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The GGCM plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the GGCM meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The GGCM plugin reports one rectilinear mesh named "GGCM mesh" (with a space). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from GGCM data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For GGCM data these are the node-centred magnetosphere fields stored in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItGGCMReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItGTCReader#

Reads HDF5 particle output of GTC, the Gyrokinetic Toroidal Code for fusion-plasma turbulence: the particles become a point mesh named "particles" with node-centred particle properties. ParaView 5.13.3 has no native GTC reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Large particle files produce large point clouds; select only the properties you need.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItGTCReader. Identity: sources/VisItGTCReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from GTC data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The GTC plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The GTC plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the GTC meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The GTC plugin reports one point mesh named "particles". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from GTC data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For GTC data these are the per-particle properties stored in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItGTCReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItGULPReader#

Reads trajectory files (.trg) from GULP, the General Utility Lattice Program for atomistic simulation: each frame becomes a time step of a point mesh of atoms named "mesh" with per-atom energy, velocity and force components. ParaView 5.13.3 has no native GULP reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Velocity and force components arrive as separate scalar arrays; combine them with calculator if you need vectors.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItGULPReader. Identity: sources/VisItGULPReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from GULP trajectory data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The GULP trajectory plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single GULP trajectory file to read (.trg); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The GULP trajectory plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the GULP trajectory meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The GULP plugin reports one point mesh of atoms named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from GULP trajectory data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For GULP trajectory data these are node-centred atom quantities such as "PE", velocity components "vx", "vy", "vz" and force components "fx", "fy", "fz". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItGULPReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItGadgetReader#

Reads snapshot files of Gadget-2, the cosmological N-body/SPH code: particle positions become a point mesh named "POS " and the other particle blocks become arrays. ParaView 5.13.3 has no native Gadget reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The plugin declares particle fields zone-centred, so they appear under CellArrayStatus (one vertex cell per particle), not PointArrayStatus.
  • The mesh name ends in a space ("POS "); a name without it selects nothing.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItGadgetReader. Identity: sources/VisItGadgetReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Gadget-2 data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Gadget-2 data these are the particle blocks of the snapshot other than positions, declared zone-centred by the plugin. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Gadget-2 plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Gadget-2 meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Gadget plugin reports one particle point mesh named "POS " (four characters, ending in a space, after the snapshot's position block label). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Gadget-2 data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Gadget-2 plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItGadgetReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItH5NimrodReader#

Reads HDF5 output of NIMROD, the extended-MHD code for fusion plasmas, in its H5Nimrod data model (.h5nimrod): a curvilinear mesh with node- and cell-centred fields over several time steps. ParaView 5.13.3 has no native NIMROD reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The plugin rejects unstructured NIMROD meshes; only the structured (curvilinear) layout is read.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItH5NimrodReader. Identity: sources/VisItH5NimrodReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from NIMROD HDF5 data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The NIMROD HDF5 plugin offers the node- and cell-centred fields stored in the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single NIMROD HDF5 file to read (.h5nimrod); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The NIMROD HDF5 plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the NIMROD HDF5 meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The H5Nimrod plugin reports a curvilinear mesh; take the name from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from NIMROD HDF5 data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The NIMROD HDF5 plugin offers the node- and cell-centred fields stored in the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItH5NimrodReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItImageReader#

Reads images through VisIt's Image plugin: PNM/PPM, Stimulate SDT/SPR and .imgvol image stacks. It offers two rectilinear meshes, "ImageMesh" with pixel values as cell data and "ImageMesh_nodal" with them as point data. For PNG, JPEG or TIFF series the native pvPNGSeriesReader, pvJPEGSeriesReader and pvTIFFSeriesReader give vtkImageData directly; pvImageReader handles headerless raw volumes. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Select the mesh that matches the arrays you want: cell arrays live on "ImageMesh" and *_nodal point arrays on "ImageMesh_nodal".
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItImageReader. Identity: sources/VisItImageReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from image data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The image plugin offers per-pixel channels; each is offered twice, as a cell array on "ImageMesh" and with the suffix _nodal as a point array on "ImageMesh_nodal"; colour formats add 4-component "color"/"color_nodal" arrays; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The image plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the image meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Image plugin reports "ImageMesh" (pixels as cells) and "ImageMesh_nodal" (pixels as points); .imgvol files stack images into a 3-D volume. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from image data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The image plugin offers per-pixel channels; each is offered twice, as a cell array on "ImageMesh" and with the suffix _nodal as a point array on "ImageMesh_nodal"; colour formats add 4-component "color"/"color_nodal" arrays; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItImageReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItLAMMPSDumpReader#

Reads LAMMPS molecular-dynamics dump files (.dump, text with ITEM: sections) in which one file holds many time steps: each step becomes a time of a point mesh of atoms with the dumped per-atom columns as point arrays. ParaView 5.13.3 has no native LAMMPS dump reader; pvVisItLAMMPSStructureReader reads LAMMPS structure files instead. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The first mesh is the box "unitCell", so without Meshes = ["mesh"] the atoms are not read.
  • Atom ids and types are numbers, not element names; map them to species yourself.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItLAMMPSDumpReader. Identity: sources/VisItLAMMPSDumpReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from LAMMPS dump data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LAMMPS dump plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single LAMMPS dump file to read (.dump); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The LAMMPS dump plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the LAMMPS dump meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The LAMMPS dump plugin reports the simulation box "unitCell" first and the point mesh of atoms "mesh" second, so by default only the box is read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from LAMMPS dump data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For LAMMPS dump data these are node-centred per-atom columns such as "id", "species" and the extra columns of the dump. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItLAMMPSDumpReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItLAMMPSStructureReader#

Reads LAMMPS atom structure files (registered for .eam, .meam, .rigid and .lammps): atom positions become a point mesh named "mesh" with per-atom id and species arrays. Use pvVisItLAMMPSDumpReader for dump trajectories. ParaView 5.13.3 has no native reader for these files. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Atom types are numbers, not element names; map them to species yourself.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItLAMMPSStructureReader. Identity: sources/VisItLAMMPSStructureReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from LAMMPS structure data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LAMMPS structure plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single LAMMPS structure file to read (.eam, .meam, .rigid, .lammps); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The LAMMPS structure plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the LAMMPS structure meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The LAMMPS structure plugin reports one point mesh of atoms named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from LAMMPS structure data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For LAMMPS structure data these are node-centred per-atom values such as "id" and "species". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItLAMMPSStructureReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItLinesReader#

Reads VisIt's ASCII Lines format (.lines): named polylines given as coordinate lists. The output is one unstructured mesh named "Lines" of line cells, with no variables. For point coordinates in CSV columns pvCSVReader with pvTableToPoints is the native route. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • There are no data arrays; colour or measure the lines with operations such as pvPointAndCellIds or calculator.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItLinesReader. Identity: sources/VisItLinesReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Lines data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Lines plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Lines plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Lines meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Lines plugin reports one unstructured mesh named "Lines"; each line in the file becomes one domain. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Lines data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Lines plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItLinesReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItM3DC1Reader#

Reads HDF5 output of M3D-C1, the high-order finite-element extended-MHD code for tokamak plasmas: the element mesh and the equilibrium mesh become unstructured blocks with node- and cell-centred fields over several time slices. The plugin's VisIt read options stay at their defaults. ParaView 5.13.3 has no native M3D-C1 reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Equilibrium and perturbed quantities live on different meshes; select the mesh that carries each array.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItM3DC1Reader. Identity: sources/VisItM3DC1Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from M3D-C1 data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The M3D-C1 plugin offers the node- and cell-centred fields of the M3D-C1 output (field components, equilibrium quantities); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single M3D-C1 file to read (.h5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The M3D-C1 plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the M3D-C1 meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The M3D-C1 plugin reports meshes such as "mesh" and "equilibrium/mesh" built from the code's triangular elements. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from M3D-C1 data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The M3D-C1 plugin offers the node- and cell-centred fields of the M3D-C1 output (field components, equilibrium quantities); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItM3DC1Reader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItM3DReader#

Reads output of M3D, the multilevel 3-D MHD code for fusion plasmas (.m3d, .h5): an unstructured mesh named "mesh" with node-centred fields over the stored time steps. ParaView 5.13.3 has no native M3D reader; for M3D-C1 output use pvVisItM3DC1Reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • M3D and M3D-C1 are different codes and formats; pick the reader that matches the code that wrote the file.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItM3DReader. Identity: sources/VisItM3DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from M3D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The M3D plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single M3D file to read (.m3d, .h5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The M3D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the M3D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The M3D plugin reports one unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from M3D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For M3D data these are the node-centred fields of the M3D output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItM3DReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItMFIXCDFReader#

Reads the netCDF-based output of MFiX (NETL's Multiphase Flow with Interphase eXchanges code): the fluid grid "Mesh" with cell-centred gas and solids fields over time, plus a "flagclass" mesh of cell flags. The native pvMFIXReader reads the classic .RES/SP* format, not this netCDF variant. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Fields are cell-centred; apply cellToPoint before operations that need point data.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItMFIXCDFReader. Identity: sources/VisItMFIXCDFReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from MFiX netCDF data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For MFiX netCDF data these are cell-centred gas and solids fields such as "Vel_g". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single MFiX netCDF file to read (.nc); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The MFiX netCDF plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the MFiX netCDF meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The MFiX netCDF plugin reports "Mesh" (rectilinear or curvilinear, depending on the case geometry) and a "flagclass" mesh describing cell flags. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from MFiX netCDF data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The MFiX netCDF plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItMFIXCDFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItMFIXReader#

Reads classic MFiX output: the .RES restart file (mesh and run information) with its SP* result files. The output is the fluid grid "Mesh" with cell-centred fields over time. The native pvMFIXReader reads the same files into an unstructured grid and is normally preferable; use this reader as a cross-check or for the flag-class mesh. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Keep the SP* files next to the .RES file; the restart file alone has no time-dependent fields.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItMFIXReader. Identity: sources/VisItMFIXReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from MFiX data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For MFiX data these are the cell-centred gas and solids fields from the SP* files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single MFiX file to read (.RES); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the .RES restart file; its SP* result files must sit beside it. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The MFiX plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the MFiX meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The MFiX plugin reports "Mesh" (rectilinear or curvilinear, depending on the case geometry) and a "flagclass" mesh describing cell flags. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from MFiX data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The MFiX plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItMFIXReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItMM5Reader#

Reads output of the PSU/NCAR Mesoscale Model (MM5) for regional weather simulation: rectilinear grids with cell-centred meteorological fields over the stored times. ParaView 5.13.3 has no native MM5 reader; netCDF output from MM5's successor WRF can often use pvNetCDFReader instead. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Grid coordinates are the model's grid, not geographic longitude and latitude; no map projection is applied.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItMM5Reader. Identity: sources/VisItMM5Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from MM5 data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For MM5 data these are the cell-centred meteorological fields of the MM5 output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single MM5 file to read (.mm5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The MM5 plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the MM5 meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The MM5 plugin reports rectilinear meshes; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from MM5 data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The MM5 plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItMM5Reader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItMiliReader#

Reads Mili, LLNL's engineering results database used by structural finite-element codes: open the .mili JSON root file, from which the plugin locates the per-processor state files. The output is a multiblock of unstructured meshes with materials and node and element results over time. ParaView 5.13.3 has no native Mili reader; the Mili plugin is an optional part of the VisIt bridge. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The VisIt bridge builds the Mili plugin only when ParaView is compiled with the Mili library; other ParaView builds lack this reader.
  • Name the arrays you need in PointArrays and CellArrays (materials in Materials): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItMiliReader. Identity: sources/VisItMiliReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Mili data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Mili plugin offers node and element results stored in the Mili database; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Mili file to read (.m, .mili); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the .mili JSON root file; it locates the state files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Mili plugin offers the materials defined in the Mili database. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Mili meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Mili plugin reports one unstructured mesh per Mili mesh; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Mili data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Mili plugin offers node and element results stored in the Mili database; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItMiliReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItMirandaReader#

Reads raw output of Miranda, LLNL's high-order hydrodynamics code for turbulent mixing, through its text .mir metadata file (gridfiles, datafiles, domainsize, blocksize, origin, spacing, variables, materials). The output is the block-decomposed "mesh" with the listed variables and material volume fractions over time. ParaView 5.13.3 has no native Miranda reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Open the .mir file; the raw block files alone carry no grid description.
  • Name the arrays you need in PointArrays and CellArrays (materials in Materials): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItMirandaReader. Identity: sources/VisItMirandaReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Miranda data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Miranda plugin offers the variables listed in the .mir file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Miranda file to read (.mir, .raw); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the text .mir metadata file; it lists the grid and data files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Miranda plugin offers materials listed in the .mir file (material set "materialset"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Miranda meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Miranda plugin reports one mesh named "mesh", rectilinear or curvilinear when grid files are given, split into blocks. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Miranda data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Miranda plugin offers the variables listed in the .mir file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItMirandaReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNASTRANReader#

Reads NASTRAN bulk data decks (.nas) into one unstructured mesh named "mesh" with element groups as materials; no results are read. The native pvBDFReader reads NASTRAN bulk data in free format; this reader also handles fixed and large-field cards, so use it when the native reader rejects a deck. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Results in .op2 or .f06 output are not read as fields; the mesh is geometry only.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNASTRANReader. Identity: sources/VisItNASTRANReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from NASTRAN bulk data data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The NASTRAN bulk data plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The NASTRAN bulk data plugin offers the property and material groups of the elements (material set "materials"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the NASTRAN bulk data meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The NASTRAN plugin reports one unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from NASTRAN bulk data data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The NASTRAN bulk data plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNASTRANReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItNek5000Reader#

Reads Nek5000 spectral-element CFD output through its small metadata file (.nek3d, .nek5000, …) whose filetemplate, firsttimestep and numtimesteps lines locate the field dumps. The output is the element mesh with node-centred velocity, pressure, temperature and scalars over time. The native pvNek5000Reader reads the same metadata file into an unstructured grid and is distributed; prefer it for parallel runs. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The first dump in the series must contain the mesh coordinates; otherwise the read fails.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNek5000Reader. Identity: sources/VisItNek5000Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Nek5000 data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Nek5000 plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Nek5000 file to read (.nek3d, .nek2d, .nek5d, .nek5000, .nek); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the small metadata file (.nek3d, .nek5000, …) whose filetemplate, firsttimestep and numtimesteps lines locate the field dumps. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Nek5000 plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Nek5000 meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Nek5000 plugin reports one mesh named "mesh" built from the spectral elements. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Nek5000 data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Nek5000 data these are node-centred fields such as "velocity", "x_velocity", "pressure", "temperature" and passive scalars. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNek5000Reader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFADAPTReader#

Reads netCDF files written by ADAPT, an LLNL atmospheric modelling format that VisIt's netCDF plugin recognises by its specific variables. One file holds one time; a list of files forms a series. For netCDF following the CF/COARDS conventions the native pvNetCDFReader is the general choice. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Opening a non-ADAPT netCDF file with this reader fails or yields nothing; check which convention the file follows.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFADAPTReader. Identity: sources/VisItNetCDFADAPTReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ADAPT netCDF data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ADAPT netCDF plugin offers the gridded fields of the ADAPT file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ADAPT netCDF plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ADAPT netCDF meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The ADAPT plugin reports its grid meshes; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ADAPT netCDF data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ADAPT netCDF plugin offers the gridded fields of the ADAPT file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFADAPTReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItNetCDFCCSM_MTSDReader#

Reads netCDF history files of the CCSM (Community Climate System Model) in which one file holds several time records; each record becomes a time step. Use pvVisItNetCDFCCSM_STSDReader when each file holds one time. The native pvNetCDFReader reads CF-compliant climate files with optional spherical coordinates and is usually the first choice. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Choose the multi-time (this) or single-time variant to match how the files store time.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFCCSM_MTSDReader. Identity: sources/VisItNetCDFCCSM_MTSDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from CCSM netCDF data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CCSM netCDF plugin offers the climate fields of the history file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single CCSM netCDF file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The CCSM netCDF plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the CCSM netCDF meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CCSM plugin reports the grid meshes of the file; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from CCSM netCDF data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CCSM netCDF plugin offers the climate fields of the history file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFCCSM_MTSDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFCCSM_STSDReader#

Reads netCDF history files of the CCSM (Community Climate System Model) that hold one time record each; a list of files forms the time series. Use pvVisItNetCDFCCSM_MTSDReader when one file holds many records. The native pvNetCDFReader reads CF-compliant climate files and is usually the first choice. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Opening a multi-record file with this variant shows only one time.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFCCSM_STSDReader. Identity: sources/VisItNetCDFCCSM_STSDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from CCSM netCDF data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CCSM netCDF plugin offers the climate fields of the history file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The CCSM netCDF plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the CCSM netCDF meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CCSM plugin reports the grid meshes of the file; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from CCSM netCDF data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The CCSM netCDF plugin offers the climate fields of the history file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFCCSM_STSDReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItNetCDFFVCOMParticleReader#

Reads Lagrangian particle-tracking files written by FVCOM (Finite-Volume Community Ocean Model): particle positions over time become a point mesh with per-particle quantities. The ocean fields themselves need pvVisItNetCDFFVCOM_MTSDReader, pvVisItNetCDFFVCOM_MTMDReader or pvVisItNetCDFFVCOM_STSDReader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Particle files carry no ocean grid; read the model output separately to show both.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFFVCOMParticleReader. Identity: sources/VisItNetCDFFVCOMParticleReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from FVCOM particle data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM particle plugin offers per-particle quantities stored in the particle file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single FVCOM particle file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The FVCOM particle plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the FVCOM particle meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The FVCOM particle plugin reports a point mesh of particles; take the name from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from FVCOM particle data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM particle plugin offers per-particle quantities stored in the particle file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFFVCOMParticleReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFFVCOM_MTMDReader#

Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels through a master file that ties several domain files together (multi-time, multi-domain). Use pvVisItNetCDFFVCOM_MTSDReader for a single file with many times and pvVisItNetCDFFVCOM_STSDReader for one time per file. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Variables live on different meshes (nodes, elements, layers, levels); select the mesh that carries each array you need.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFFVCOM_MTMDReader. Identity: sources/VisItNetCDFFVCOM_MTMDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from FVCOM data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single FVCOM file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The FVCOM plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the FVCOM meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The FVCOM plugin reports the 2-D grid and the sigma-layer and sigma-level meshes (for example "Sigma_Layers", "Sigma_Levels"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from FVCOM data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFFVCOM_MTMDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFFVCOM_MTSDReader#

Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels where one file holds many time records. Use pvVisItNetCDFFVCOM_MTMDReader for multi-domain master files and pvVisItNetCDFFVCOM_STSDReader for one time per file. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Variables live on different meshes (nodes, elements, layers, levels); select the mesh that carries each array you need.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFFVCOM_MTSDReader. Identity: sources/VisItNetCDFFVCOM_MTSDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from FVCOM data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single FVCOM file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The FVCOM plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the FVCOM meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The FVCOM plugin reports the 2-D grid and the sigma-layer and sigma-level meshes. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from FVCOM data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFFVCOM_MTSDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFFVCOM_STSDReader#

Reads FVCOM (Finite-Volume Community Ocean Model) netCDF output on an unstructured triangular grid with sigma layers and levels where each file holds one time; a list of files forms the series. Use pvVisItNetCDFFVCOM_MTSDReader when one file holds many times. If the output follows the UGRID conventions, the native pvNetCDFUGRIDreader is an alternative. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Variables live on different meshes (nodes, elements, layers, levels); select the mesh that carries each array you need.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFFVCOM_STSDReader. Identity: sources/VisItNetCDFFVCOM_STSDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from FVCOM data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The FVCOM plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the FVCOM meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The FVCOM plugin reports the 2-D grid and the sigma-layer and sigma-level meshes. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from FVCOM data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The FVCOM plugin offers the ocean fields (velocity, temperature, salinity, elevation, …) of the output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFFVCOM_STSDReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItNetCDFLODIParticleReader#

Reads netCDF particle files of LODI, LLNL's Lagrangian atmospheric dispersion model: particle positions over time become a point mesh with per-particle quantities and, where defined, source groups as materials. Gridded LODI concentrations need pvVisItNetCDFLODIReader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Positions are in the model's coordinate system; no geographic projection is applied.
  • Name the arrays you need in PointArrays and CellArrays (materials in Materials): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFLODIParticleReader. Identity: sources/VisItNetCDFLODIParticleReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from LODI particle data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LODI particle plugin offers per-particle quantities stored in the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single LODI particle file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The LODI particle plugin offers particle source identifiers (material set "sourceid") when the file defines them. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the LODI particle meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The LODI particle plugin reports a point mesh of particles named "particles". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from LODI particle data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LODI particle plugin offers per-particle quantities stored in the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFLODIParticleReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItNetCDFLODIReader#

Reads gridded netCDF output of LODI, LLNL's Lagrangian atmospheric dispersion model, with several time records in one file. Particle files of the same model need pvVisItNetCDFLODIParticleReader; generic CF-compliant netCDF uses pvNetCDFReader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Coordinates are the model grid; no geographic projection is applied.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItNetCDFLODIReader. Identity: sources/VisItNetCDFLODIReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from LODI data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LODI plugin offers the gridded dispersion fields of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single LODI file to read (.nc, .cdf, .elev, .ncd); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The LODI plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the LODI meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The LODI plugin reports its grid meshes; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from LODI data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The LODI plugin offers the gridded dispersion fields of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItNetCDFLODIReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItOVERFLOWReader#

Reads binary Fortran grid and solution files of NASA's OVERFLOW overset-grid CFD solver (.dat, .save): every overlapping curvilinear grid becomes a domain of "mesh" with node-centred solution variables. The native pvPLOT3DReader reads standard PLOT3D grid and solution files; use this reader for OVERFLOW's own files. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Overset grids overlap; integrals or statistics over all blocks count the overlapping regions more than once.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItOVERFLOWReader. Identity: sources/VisItOVERFLOWReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from OVERFLOW data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The OVERFLOW plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The OVERFLOW plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the OVERFLOW meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The OVERFLOW plugin reports one curvilinear mesh named "mesh" whose domains are the overset grids. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from OVERFLOW data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For OVERFLOW data these are the node-centred solution (Q) variables. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItOVERFLOWReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItOpenFOAMReader#

Reads an OpenFOAM case through VisIt's OpenFOAM plugin (a variant of VTK's OpenFOAM reader): open the case's system/controlDict file. The output is a multiblock with the selected internal mesh, patches, zones and Lagrangian clouds, with fields over all time directories. Prefer foam (Schemaxis-curated, with checked defaults) or the native pvOpenFOAMReader, which handle decomposed cases and region selection; this reader is mainly a cross-check. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The plugin's VisIt read options (for example decomposed versus reconstructed handling) cannot be changed here; use foam or pvOpenFOAMReader when you need them.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItOpenFOAMReader. Identity: sources/VisItOpenFOAMReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from OpenFOAM data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The OpenFOAM plugin offers the volume (cell) and point fields of the case; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single OpenFOAM file to read (controlDict); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Name the case's system/controlDict file. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The OpenFOAM plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the OpenFOAM meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The OpenFOAM plugin reports "internalMesh", the boundary patches, "Regions", cell, face and point zones, and Lagrangian clouds as separate meshes. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from OpenFOAM data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The OpenFOAM plugin offers the volume (cell) and point fields of the case; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItOpenFOAMReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItPATRANReader#

Reads MSC PATRAN neutral files (.neu), ASCII packet files describing unstructured finite-element geometry: one unstructured mesh named "mesh" with element attributes as cell arrays and named components as materials. ParaView 5.13.3 has no native PATRAN reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Named components arrive as material volume fractions (1 or -1 per element); threshold them above 0 to extract a component.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPATRANReader. Identity: sources/VisItPATRANReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from PATRAN neutral data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For PATRAN neutral data these are the cell-centred element attributes of the neutral file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The PATRAN neutral plugin offers the named components of the model (material set "named_components"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the PATRAN neutral meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The PATRAN plugin reports one unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from PATRAN neutral data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The PATRAN neutral plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPATRANReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItPFLOTRANReader#

Reads HDF5 output of PFLOTRAN, the parallel subsurface flow and reactive-transport code: a rectilinear grid named "mesh" with cell-centred fields for every output time and material ids as materials. ParaView 5.13.3 has no native PFLOTRAN reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Array names include units and spaces (for example "Total H+ [m]"); copy them exactly.
  • Name the arrays you need in PointArrays and CellArrays (materials in Materials): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPFLOTRANReader. Identity: sources/VisItPFLOTRANReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from PFLOTRAN data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For PFLOTRAN data these are the cell-centred fields of each output time (for example concentrations such as "Total H+ [m]"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single PFLOTRAN file to read (.h5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The PFLOTRAN plugin offers material ids from a "Material_ID" field when present. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the PFLOTRAN meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The PFLOTRAN plugin reports one rectilinear mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from PFLOTRAN data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The PFLOTRAN plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPFLOTRANReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItPLOT2DReader#

Registers VisIt's PLOT3D plugin for 2-D .p2d grid files. Because the plugin's read options stay at their 3-D binary defaults and a .p2d name is neither a .vp3d meta file nor a .x/.q pair, it is not established that 2-D files are read correctly. Prefer the native pvPLOT3DReader, whose properties describe the file variant explicitly. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Verify the grid dimensions after reading; use pvPLOT3DReader when the file is not a 3-D binary single grid.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPLOT2DReader. Identity: sources/VisItPLOT2DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from PLOT2D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The PLOT2D plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The PLOT2D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the PLOT2D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The PLOT3D plugin reports one curvilinear mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from PLOT2D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For PLOT2D data these are the node-centred PLOT3D solution variables (density, momentum, energy and derived quantities). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPLOT2DReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItPLOT3DReader#

Reads NASA PLOT3D structured grid (.x) and solution (.q) files described by a VisIt .vp3d text meta file. The output is a curvilinear "mesh" with one domain per grid and node-centred solution variables. The native pvPLOT3DReader (properties for each variant) and pvPLOT3DMetaFileReader (JSON .p3d time series) are normally preferable. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Describe the variant in the .vp3d file; otherwise the defaults (C binary, 3-D, single grid, big-endian, single precision) are assumed and other files are misread.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPLOT3DReader. Identity: sources/VisItPLOT3DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from PLOT3D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The PLOT3D plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The PLOT3D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the PLOT3D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The PLOT3D plugin reports one curvilinear mesh named "mesh", with one domain per grid. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from PLOT3D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For PLOT3D data these are the node-centred PLOT3D solution variables (density, momentum, energy and derived quantities such as Mach number). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPLOT3DReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItParaDiSTecplotReader#

Reads the Tecplot-like text output of ParaDiS, LLNL's Parallel Dislocation Simulator: dislocation nodes and segments become point and polyline meshes with their quantities. For ParaDiS's own data files use pvVisItParaDisReader; general Tecplot ASCII uses pvTecplotReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The .dat extension is shared with many formats; make sure the file is ParaDiS Tecplot-style output.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItParaDiSTecplotReader. Identity: sources/VisItParaDisTecplotReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ParaDiS Tecplot-style data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ParaDiS Tecplot-style plugin offers the node and segment quantities of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ParaDiS Tecplot-style plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ParaDiS Tecplot-style meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The plugin reports point and line meshes such as "paraDIS_Tecplot_point_mesh" and "paraDIS_Tecplot_poly_mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ParaDiS Tecplot-style data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ParaDiS Tecplot-style plugin offers the node and segment quantities of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItParaDiSTecplotReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItParaDisReader#

Reads data files of ParaDiS, LLNL's Parallel Dislocation Simulator: dislocation segments, nodes and the derived meta-arms become line and point meshes, with Burgers-vector and arm classifications as materials and per-node and per-segment arrays. Use pvVisItParaDisTecplotReader for the Tecplot-like text output. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Classifications arrive as material volume fractions; threshold them above 0 to extract one class.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItParaDisReader. Identity: sources/VisItParaDisReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from ParaDiS data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ParaDiS plugin offers node and segment quantities such as "Node-Type", "Segment-Burgers-Type" and "Segment-Index"; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The ParaDiS plugin offers classifications such as Burgers-vector type and meta-arm type. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the ParaDiS meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The ParaDiS plugin reports meshes such as "segments", "nodes", "Meta Arms" and "Wrapped Meta Arms". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from ParaDiS data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The ParaDiS plugin offers node and segment quantities such as "Node-Type", "Segment-Burgers-Type" and "Segment-Index"; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItParaDisReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItPixieReader#

Reads 2-D and 3-D HDF5 output of the Pixie3D extended-MHD code: rectilinear or curvilinear grids with node- and cell-centred fields over the stored time steps. ParaView 5.13.3 has no native Pixie reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Many codes write .h5 files; make sure the file is Pixie3D output before choosing this reader.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPixieReader. Identity: sources/VisItPixieReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Pixie3D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Pixie3D plugin offers the node- and cell-centred fields of the HDF5 file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Pixie3D file to read (.h5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Pixie3D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Pixie3D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Pixie plugin reports rectilinear or curvilinear meshes depending on the run, and point meshes for particles. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Pixie3D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Pixie3D plugin offers the node- and cell-centred fields of the HDF5 file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPixieReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItPoint3DReader#

Reads an ASCII table of x, y, z and data-value columns (.3D): every row becomes a point and every column a point array. The native route for such tables is pvCSVReader followed by pvTableToPoints, which also handles more columns and other delimiters. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The plugin expects coordinate columns followed by one value column; use pvCSVReader for wider tables.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItPoint3DReader. Identity: sources/VisItPoint3DReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Point3D data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Point3D plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Point3D plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Point3D meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Point3D plugin reports one point mesh. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Point3D data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Point3D data these are one point array per column, named from the header line (the coordinate columns included). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItPoint3DReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItProteinDataBankReader#

Reads Protein Data Bank files (.pdb, .ent) of macromolecular structures: atoms become a point mesh with numeric per-atom arrays (element, residue type and sequence, backbone flag, occupancy, temperature factor). The native pvPDBReader produces molecule geometry for ball-and-stick rendering; choose this reader when you need the per-atom attributes as arrays. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Text attributes such as atom and residue names are VisIt labels and are not converted.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItProteinDataBankReader. Identity: sources/VisItProteinDataBankReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Protein Data Bank data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Protein Data Bank plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Protein Data Bank plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Protein Data Bank meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The PDB plugin reports a point mesh of atoms named "mesh"; multi-model files add one mesh per model under "models/model_NN/". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Protein Data Bank data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Protein Data Bank data these are per-atom values such as "element", "restype", "resseq", "backbone", "occupancy" and "tempFactor" (numeric only). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItProteinDataBankReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItRAWReader#

Reads the ASCII RAW triangle format used to exchange geometry with programs such as POV-Ray and Blender: each line is one triangle, grouped into named objects, giving a polygonal surface mesh "mesh" with one domain per object and no variables. It is not a raw binary image reader; use pvImageReader for raw volumes. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Binary .raw image volumes are a different format; this plugin rejects non-ASCII files.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItRAWReader. Identity: sources/VisItRAWReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from RAW triangle data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The RAW triangle plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The RAW triangle plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the RAW triangle meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The RAW plugin reports one surface mesh named "mesh" whose domains are the named objects of the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from RAW triangle data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The RAW triangle plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItRAWReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItSAMRAIReader#

Reads output of SAMRAI, LLNL's Structured Adaptive Mesh Refinement Application Infrastructure, through the .samrai summary file of each time step: patches on refinement levels become vtkOverlappingAMR when only "amr_mesh" is selected. Materials are converted; SAMRAI species are not. The captured ParaView summary ("Reads Specific Absorption Rate image volume files") is copied from pvVisItSARReader and is wrong. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Use pvConvertAMRdatasettoMultiblock or merge before operations that need ordinary datasets.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItSAMRAIReader. Identity: sources/VisItSAMRAIReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from SAMRAI data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The SAMRAI plugin offers the patch variables of the SAMRAI output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The SAMRAI plugin offers material volume fractions when the output defines materials. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the SAMRAI meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The SAMRAI plugin reports the AMR mesh "amr_mesh"; selecting it alone gives vtkOverlappingAMR output. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from SAMRAI data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The SAMRAI plugin offers the patch variables of the SAMRAI output; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItSAMRAIReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItSARReader#

Reads Specific Absorption Rate (SAR) image volumes (.sar): a 3-D rectilinear grid named "mesh" with one point array "SAR", the radio-frequency energy absorption per voxel. The plugin source documents no units, so treat values as stored in the file. Use pvVisItSAMRAIReader for SAMRAI AMR files despite the shared upstream description. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • No unit conversion is applied; confirm the units (often W/kg) with the tool that wrote the file.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItSARReader. Identity: sources/VisItSARReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from SAR data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The SAR plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The SAR plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the SAR meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The SAR plugin reports one 3-D rectilinear mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from SAR data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For SAR data these are one node-centred variable, "SAR". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItSARReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItSASReader#

Reads binary Fortran SAS geometry and data files (.sasgeom with .sas/.sasdata): an unstructured mesh of assemblies and channels with cell arrays identifying each assembly and channel and a temperature field over time. The plugin source gives no further description of the producing code; ParaView has no other reader for it. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Keep the geometry and data files together; the data file alone has no mesh.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItSASReader. Identity: sources/VisItSASReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from SAS data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For SAS data these are cell arrays "assembly_id", "assembly_type", "channel_id", "channel_type" and "temperature". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single SAS file to read (.sasgeom, .sas, .sasdata); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Keep the .sasgeom geometry and the data files together. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The SAS plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the SAS meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The SAS plugin reports one unstructured mesh of assemblies and channels; take the name from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from SAS data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The SAS plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItSASReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItSiloReader#

Reads LLNL Silo files (PDB or HDF5 driver): rectilinear and curvilinear quad meshes, unstructured UCD meshes, point meshes and CSG meshes (discretized), multi-block objects, variables and materials. Silo is the native format of many LLNL codes and of VisIt. ParaView 5.13.3 has no native Silo reader; this plugin is an optional part of the VisIt bridge. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The .pdb extension is shared with Protein Data Bank files; choose the reader by content, not extension.
  • Silo species, tensors and expressions defined in the file are not converted by the bridge.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItSiloReader. Identity: sources/VisItSiloReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Silo data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Silo plugin offers the node- and zone-centred variables of the Silo file (multivars included); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Silo plugin offers the materials of Silo material objects (multimats included). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Silo meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Silo plugin reports every mesh in the file: quad (rectilinear or curvilinear), unstructured (UCD), point and CSG meshes, and multimeshes that gather per-domain files. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Silo data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Silo plugin offers the node- and zone-centred variables of the Silo file (multivars included); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItSiloReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItSpheralReader#

Reads ASCII output of Spheral++, LLNL's smoothed-particle hydrodynamics code with coupled gravity: SPH nodes become point meshes with node-centred fields, and node lists are also offered as materials. ParaView 5.13.3 has no native Spheral reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The output is a point cloud of SPH nodes; interpolate it (for example with pvSPHVolumeInterpolator) before operations that need a grid.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItSpheralReader. Identity: sources/VisItSpheralReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Spheral++ data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Spheral++ plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Spheral++ plugin offers the node lists treated as materials (material set "Materials"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Spheral++ meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Spheral plugin reports point meshes of SPH nodes (named after the node lists, for example "Node List"). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Spheral++ data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Spheral++ data these are the node-centred fields of each node list (density, velocity and similar). {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItSpheralReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItTFTReader#

Intended for ASCII results of the TFT Fortran simulation code (.dat, .tft). The plugin publishes them as VisIt curves, but the bridge converts only meshes, so the output is probably empty; this has not been verified. For tabular text use pvCSVReader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Expect no geometry until a native check shows otherwise.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItTFTReader. Identity: sources/VisItTFTReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from TFT data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The TFT plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The TFT plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the TFT meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The TFT plugin publishes its data as VisIt curve objects, not meshes, so the bridge may list no meshes here. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from TFT data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The TFT plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItTFTReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItTSurfReader#

Reads GOCAD TSurf triangulated surfaces (geological horizons and faults; ASCII with a "GOCAD TSurf" header, vertex and triangle records) into one unstructured triangle mesh named "mesh" without variables. ParaView 5.13.3 has no native GOCAD reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Vertex properties are not converted; only the triangulated geometry is read.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItTSurfReader. Identity: sources/VisItTSurfReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from GOCAD TSurf data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The GOCAD TSurf plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The GOCAD TSurf plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the GOCAD TSurf meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The TSurf plugin reports one unstructured triangle mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from GOCAD TSurf data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The GOCAD TSurf plugin defines no variables, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItTSurfReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItTecplotBinaryReader#

Reads a subset of Tecplot's binary .plt format: ordered and finite-element zones become structured or unstructured blocks with their variables. ParaView's native pvTecplotReader reads only ASCII Tecplot, so this is the catalogue's reader for binary .plt files (SZL .szplt files are a different format). FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Only a subset of the binary format is supported; check zone counts and variables against Tecplot.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItTecplotBinaryReader. Identity: sources/VisItTecplotBinaryReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Tecplot binary data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Tecplot binary plugin offers the zone variables (point- or cell-centred according to the file); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Tecplot binary plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Tecplot binary meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Tecplot binary plugin reports the meshes formed by the file's zones; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Tecplot binary data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Tecplot binary plugin offers the zone variables (point- or cell-centred according to the file); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItTecplotBinaryReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItTecplotReader#

Reads a subset of ASCII Tecplot (.tec, .tp): ordered (IJK) and finite-element zones become structured or unstructured domains with their variables. The native pvTecplotReader (multiblock of zones) is normally preferable; use this reader when it rejects a file. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Only a subset of ASCII Tecplot is supported; check zone counts and variables against Tecplot.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItTecplotReader. Identity: sources/VisItTecplotReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Tecplot ASCII data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Tecplot ASCII plugin offers the zone variables (point- or cell-centred according to the file); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Tecplot ASCII plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Tecplot ASCII meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Tecplot plugin reports meshes such as "mesh" (zones as domains) and, for point zones, "points/mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Tecplot ASCII data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Tecplot ASCII plugin offers the zone variables (point- or cell-centred according to the file); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItTecplotReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItTetradReader#

Reads Tetrad HDF5 files (a format written for INEEL, now Idaho National Laboratory): a tetrahedral unstructured mesh named "mesh" with cell-centred variables over the stored time steps. ParaView 5.13.3 has no native Tetrad reader. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Many codes write .h5 files; make sure the file is Tetrad output.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItTetradReader. Identity: sources/VisItTetradReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from Tetrad data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For Tetrad data these are the cell-centred variables stored with the tetrahedra. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single Tetrad file to read (.hdf5, .h5); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Tetrad plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the Tetrad meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Tetrad plugin reports one unstructured mesh named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from Tetrad data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Tetrad plugin declares its variables zone-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItTetradReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItUNICReader#

Reads HDF5 result files of UNIC, Argonne's unstructured-mesh neutron transport code: unstructured meshes with node- and cell-centred results. ParaView 5.13.3 has no native UNIC reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Many codes write .h5 files; make sure the file is UNIC output.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItUNICReader. Identity: sources/VisItUNICReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from UNIC data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The UNIC plugin offers the node- and cell-centred results (for example neutron fluxes); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The UNIC plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the UNIC meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The UNIC plugin reports unstructured meshes; take the names from the reader's available list. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from UNIC data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The UNIC plugin offers the node- and cell-centred results (for example neutron fluxes); which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItUNICReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItVASPCHGCARReader#

Reads VASP (Vienna Ab initio Simulation Package) charge-density files (CHGCAR or CHG; the reader matches names starting with CHG): the density on the unit-cell grid becomes a point array "charge", with atom and unit-cell meshes alongside. ParaView's pvVASPAnimationReader and pvVASPTessellationReader read different VASP files, not CHGCAR. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • The first mesh is "atoms"; select "mesh" to get the charge-density grid.
  • No rescaling is applied: "charge" holds the values as stored in the file (VASP writes density times cell volume).
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItVASPCHGCARReader. Identity: sources/VisItVASPCHGCARReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from VASP CHGCAR data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The VASP CHGCAR plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single VASP CHGCAR file to read (CHG*); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). The file is usually named CHGCAR or CHG (no extension). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The VASP CHGCAR plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the VASP CHGCAR meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The CHGCAR plugin reports the atom point mesh "atoms" first and the charge-density grid "mesh" second, so by default only the atoms are read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from VASP CHGCAR data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For VASP CHGCAR data these are the node-centred "charge" density on the grid. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItVASPCHGCARReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItVASPOUTCARReader#

Reads VASP (Vienna Ab initio Simulation Package) OUTCAR files (names starting with OUT): every ionic step becomes a time step of a point mesh of atoms with element and force components, plus the unit cell. Use pvVisItVASPPOSCARReader for a single structure and pvVisItVASPCHGCARReader for charge densities. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • Forces arrive as separate scalar components; combine them with calculator to get vectors.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItVASPOUTCARReader. Identity: sources/VisItVASPOUTCARReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from VASP OUTCAR data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The VASP OUTCAR plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single VASP OUTCAR file to read (OUT*); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). The file is usually named OUTCAR (no extension). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The VASP OUTCAR plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the VASP OUTCAR meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The OUTCAR plugin reports the point mesh of atoms "mesh" and the unit-cell mesh "unitCell". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from VASP OUTCAR data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For VASP OUTCAR data these are node-centred per-atom values such as "element" and force components "fx", "fy", "fz". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItVASPOUTCARReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItVASPPOSCARReader#

Reads VASP (Vienna Ab initio Simulation Package) structure files (POSCAR, names starting with POS): atom positions become a point mesh with an element array, plus the unit cell. Listing several files gives a series. Use pvVisItVASPOUTCARReader for relaxation or dynamics trajectories. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Only the first mesh (the atoms) is read by default; add "unitCell" to MeshStatus to get the cell outline.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItVASPPOSCARReader. Identity: sources/VisItVASPPOSCARReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from VASP POSCAR data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The VASP POSCAR plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The VASP POSCAR plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the VASP POSCAR meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The POSCAR plugin reports the point mesh of atoms "mesh" and the unit-cell mesh "unitCell". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from VASP POSCAR data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For VASP POSCAR data these are node-centred per-atom values such as "element". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItVASPPOSCARReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItVelodyneReader#

Reads HDF5 result files of Velodyne, Corvid Technologies' structural mechanics code (.vld, .rst): solid, shell, surface, particle and SPH meshes with materials and node and element results. It is unrelated to Velodyne lidar data; pvVelodyneAMRReader reads a different (XAMR AMR) format. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Only the first mesh the plugin reports is read by default; list every element type (solid, shell, SPH, particle) you need.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus (materials in MaterialStatus): the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItVelodyneReader. Identity: sources/VisItVelodyneReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from Velodyne data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Velodyne plugin offers the node and element results of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The Velodyne plugin offers the materials of the model. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the Velodyne meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Velodyne plugin reports meshes such as "Solid", "Shell", "Surface", "Particle", "SPH", "Node" and "TiedNode". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from Velodyne data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The Velodyne plugin offers the node and element results of the file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItVelodyneReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItVsReader#

Reads HDF5 files annotated with VizSchema markup (.h5, .vsh5), the convention used by Tech-X simulation codes such as VSim/Vorpal to describe meshes, variables and particles. The output is a multiblock of the declared meshes with their variables. ParaView 5.13.3 has no native VizSchema reader. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • Files without VizSchema attributes produce nothing; generic HDF5 needs another reader.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItVsReader. Identity: sources/VisItVsReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from VizSchema data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The VizSchema plugin offers the variables described by the file's VizSchema markup; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The VizSchema plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the VizSchema meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The VizSchema plugin reports the uniform, rectilinear, structured, unstructured and particle meshes declared in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from VizSchema data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The VizSchema plugin offers the variables described by the file's VizSchema markup; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItVsReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVisItXYZReader#

Reads XYZ molecular files (atom count, comment line, then element and x y z per atom, optionally more columns); several frames in one file become time steps of a point mesh with element and extra-column arrays. The native pvXYZReader produces a vtkMolecule for molecular rendering; choose this reader for frame-by-frame point data or extra columns. One file supplies every time step the format stores.

Common mistakes and assumptions:

  • No bonds are created; use pvXYZReader or a molecule operation when you need them.
  • Name the arrays you need in PointArrays and CellArrays: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItXYZReader. Identity: sources/VisItXYZReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrays Names of the zone-centred (cell) variables to read from XYZ data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The XYZ plugin declares its variables node-centred, so this list normally stays empty. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Path of the single XYZ file to read (.xyz); the reader takes every time step the format stores from it. Use an absolute path; relative paths are not resolved against the JSON file's folder (Studio uses the directory it was launched from). Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Materials Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The XYZ plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Meshes Names of the XYZ meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The XYZ plugin reports one point mesh of atoms named "mesh". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrays Names of the node-centred (point) variables to read from XYZ data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. For XYZ data these are node-centred per-atom values: "element" (atomic number) and any extra columns. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItXYZReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvVisItXmdvReader#

Reads XmdvTool .okc files, a simple ASCII format for multivariate records (header with variable count, names and ranges, then one record per line). Each record becomes a point whose coordinates are the first three variables, and every variable becomes an array. For general delimited tables pvCSVReader is the native route. FileName takes a list of files, each one time step of a series (ParaView's file-series wrapper).

Common mistakes and assumptions:

  • The point positions are just the first three variables; reorder columns if other variables should define the coordinates.
  • Name the arrays you need in PointArrayStatus and CellArrayStatus: the VisIt bridge starts with every variable unselected, so omitting them normally gives geometry without fields.
  • The VisIt plugin's own read options stay at their defaults; the ParaView proxy exposes no property to change them.
  • Schemaxis generates this binding from ParaView's catalogue and has not run a native acceptance check for this reader; check meshes, arrays and times on your own data.

Native constructor: VisItXmdvReader. Identity: sources/VisItXmdvReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the zone-centred (cell) variables to read from XmdvTool data; each becomes a cell-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The XmdvTool plugin offers one array per variable column of the .okc file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
MaterialStatus Names of materials to convert into volume-fraction cell arrays. For each selected material the bridge adds a float cell array named after it: 1 in cells made only of that material, its volume fraction in mixed cells and -1 where it is absent. The XmdvTool plugin defines no materials, so this list has nothing to select. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
MeshStatus Names of the XmdvTool meshes to read. Each selected mesh becomes one named block of the multiblock output and unlisted meshes are skipped. The Xmdv plugin reports one point mesh named "points". {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the node-centred (point) variables to read from XmdvTool data; each becomes a point-data array on every selected mesh that defines it. Vector variables arrive as one multi-component array, while VisIt expressions and tensor, label, species and array variables are not converted by the bridge. The XmdvTool plugin offers one array per variable column of the .okc file; which of them appear here depends on how each is centred in the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVisItXmdvReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvVolumeOfRevolution#

Sweeps a 2-D (planar) dataset about an axis to create a 3-D unstructured grid: vertices become lines, lines become quadrilaterals and 2-D cells become volume cells, with point and cell data copied to each swept copy. Use it to build a 3-D volume from an axisymmetric simulation for visualization or export. The axis is given by AxisPosition and AxisDirection (ParaView default: the x axis through the origin) and the sweep by SweepAngle and Resolution. ParaView's own short description of this filter (elevation) is a copying error.

Common mistakes and assumptions:

  • The axis must not cross the geometry, or the output has intersecting cells.
  • Vector arrays such as velocity are copied unchanged to every swept copy, not rotated; their components are only meaningful in the original plane.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: VolumeOfRevolution. Identity: filters/VolumeOfRevolution. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AxisDirection The direction of the axis of revolution. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
AxisPosition Position of the rotational axis in 3D space. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Resolution Sets the number of samples to create about the Sweep Angle. Each segment in the output is created in equal-angle segments. {"type":"integer"} native initialisation / omitted 1
SweepAngle Sets the angle (in degrees) of the rotational sweep to perform. Valid range is 0 to 360. {"maximum":360.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVolumeOfRevolution",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvVoronoiMergeConnected#

Merges the cells of a Voronoi tessellation that share the same global RegionId into single polyhedron cells (vtkPMergeConnected), turning per-particle Voronoi cells into one cell per connected region. Input is a multiblock of unstructured grids carrying RegionId on points and cells and a Volumes cell array, as produced by ParaView's cosmology Voronoi tools; output is a multiblock with merged polyhedra, RegionId and summed Volumes. pvMinkowskiFilter can then characterize the shapes.

Common mistakes and assumptions:

  • Inputs without the vtkIdType RegionId arrays and float Volumes array are not handled by the native code; it is not a general mesh-merging filter (use merge or pvMergeBlocks for that).
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: VoronoiMergeConnected. Identity: filters/PMergeConnected. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input for this filter. Accepted data: multiblock datasets (vtkMultiBlockDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVoronoiMergeConnected",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvVortexCores#

Extracts vortex core lines with the parallel-vectors method: lines where velocity is parallel to acceleration (or to jerk with UseHigherOrderMethod). Candidate cells are prefiltered with the Q and delta criteria, and the output polylines carry q-criterion, delta-criterion, lambda_2-criterion, lambda_ci-criterion and vorticity_magnitude point arrays for further filtering. Only 3-D linear cells are processed and the vector field must be a 3-component point array. Use it to locate swirling-flow axes; for vortex regions rather than lines, compute Q or lambda2 with gradient and contour them.

Common mistakes and assumptions:

  • Surface or 2-D meshes and higher-order cells produce no output; supply a linear volume mesh.
  • The method is sensitive to noise and finds short spurious segments; threshold the output on the criterion arrays.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: VortexCores. Identity: filters/VortexCores. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: The input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). The input needs at least one point- or cell-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FasterApproximation When this option is enabled, the gradient filter used to compute vortex cores will provide a less accurate algorithm that performs fewer derivative calculations and is therefore faster. {"type":"boolean"} native initialisation / omitted false
UseHigherOrderMethod Use the flow field's jerk instead of acceleration as the second vector field during the parallel vector operation. Disabled by default. {"type":"boolean"} native initialisation / omitted false
VectorField This property indicates the name of the vector array from which to compute vortex cores. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvVortexCores",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvWarpByScalar#

Displaces each point along a direction by ScaleFactor × its scalar value: x' = x + ScaleFactor · s · n, with n the point normal when the input has normals and UseNormal is false, otherwise the constant Normal. XYPlane uses each point's z coordinate as s and warps along z (carpet plots). Polydata, structured and unstructured grids keep their type; image and rectilinear inputs become structured grids. Use it for elevation or carpet plots of a scalar on a surface; the curated warpScalar covers the common case.

Common mistakes and assumptions:

  • If the surface has point normals they are used unless UseNormal is true, so Normal may appear to be ignored.
  • ScaleFactor stays 1.0 unless set (ParaView's NoDefault hint), so a scalar in pascals moves points by thousands of length units; choose a factor relative to the data range.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: WarpByScalar. Identity: filters/WarpScalar. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). The input needs at least one point-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
GenerateEnclosure If this value is checked and the active dataset is a 2D surface, generate a water-tight enclosure containing the initial surface, the warped surface and "side walls". {"type":"boolean"} native initialisation / omitted false
Normal The values of this property specify the direction along which to warp the dataset if any normals contained in the input dataset are not being used for this purpose. (See the UseNormal property.) {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Scalars This property contains the name of the scalar array by which to warp the dataset. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
ScaleFactor The scalar value at a given point is multiplied by the value of this property to determine the magnitude of the change vector for that point. {"type":"number"} native initialisation / omitted 1
UseNormal If point normals are present in the dataset, the value of this property toggles whether to use a single normal value (value = 1) or the normals from the dataset (value = 0). {"type":"boolean"} native initialisation / omitted false
XYPlane If the value of this property is 1, then the Z-coordinates from the input are considered to be the scalar values, and the displacement is along the Z axis. This is useful for creating carpet plots. {"type":"boolean"} native initialisation / omitted false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvWarpByScalar",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvWarpByVector#

Displaces each point by ScaleFactor × a 3-component point vector (x' = x + ScaleFactor · v), e.g. structural displacements or mode shapes, to show the deformed shape. Polydata, structured and unstructured grids keep their type; image and rectilinear inputs become structured grids. Point and cell data pass through, but input normals are dropped because the geometry changed. The curated warpVector covers the common case.

Common mistakes and assumptions:

  • Use a ScaleFactor of 1 for true displacements; larger factors exaggerate deformation, so state the factor in published images.
  • Recompute normals after warping for correct shading.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: WarpByVector. Identity: filters/WarpVector. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the filter. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). The input needs at least one point-centred array with 3 components. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ScaleFactor Each component of the selected vector array will be multiplied by the value of this property before being used to compute new point coordinates. {"type":"number"} native initialisation / omitted 1
Vectors The value of this property contains the name of the vector array by which to warp the dataset's point coordinates. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvWarpByVector",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvWavefrontOBJReader#

Reads Wavefront .obj geometry into polydata with polygons and lines, keeping normals and texture coordinates when the file provides them. Materials (.mtl) are not applied to the data. Use it for surface models exported by modelling or CAD tools; use readSTL for STL and pvglTFReader for glTF scenes.

Common mistakes and assumptions:

  • OBJ has no unit convention; check whether coordinates are millimetres or metres before combining with simulation data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: WavefrontOBJReader. Identity: sources/objreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the OBJ reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvWavefrontOBJReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvWavelet#

Generates image data over WholeExtent (spacing SubsampleRate, origin 0) with the point scalar "RTData" = Maximum·exp(-r²/(2·StandardDeviation²)) + XMag·sin(XFreq·x) + YMag·sin(YFreq·y) + ZMag·cos(ZFreq·z), where x, y, z are offsets from Center divided by the extent width on each axis and r is their length. It is ParaView's standard synthetic volume, used to test contouring, slicing, volume rendering and exports. The curated wavelet operation offers Schemaxis defaults.

Common mistakes and assumptions:

  • The native documentation writes the terms as a product; VTK adds them, so the Gaussian and the waves superpose.
  • Center is in index coordinates, not physical units, because spacing is 1 (or SubsampleRate).
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: Wavelet. Identity: sources/RTAnalyticSource. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center Centre of the Gaussian and origin of the wave coordinates, in grid-index units: for each point, x, y and z are the offsets of its grid index from Center, divided by the extent width on that axis, and the Gaussian depends on their length r. It is not in physical units. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
Maximum This parameter specifies the maximum value (M) of the function. {"type":"number"} native initialisation / omitted 1
StandardDeviation This property specifies the standard deviation of the Gaussian used in computing this function. {"type":"number"} native initialisation / omitted 1
SubsampleRate This property specifies the rate at which to subsample the volume. The extent of the dataset in each dimension will be divided by this value. (See the Whole Extent property.) {"minimum":1,"type":"integer"} native initialisation / omitted 1
WholeExtent The six values in this property indicate the X, Y, and Z extent of the output data. The first two values represent the minimum and maximum X indices, the next two are the minimum and maximum Y indices, and the last two are the minimum and maximum Z indices. {"items":{"type":"integer"},"maxItems":6,"minItems":6,"type":"array"} native initialisation / omitted [1,1,1,1,1,1]
XFreq Natural frequency of the x wave, the XFreq in XMag·sin(XFreq·x); x is the offset from Center divided by the extent width in x. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1
XMag Amplitude of the x wave: the term XMag·sin(XFreq·x) that is added to RTData. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1
YFreq Natural frequency of the y wave, the YFreq in YMag·sin(YFreq·y); y is the offset from Center divided by the extent width in y. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1
YMag Amplitude of the y wave: the term YMag·sin(YFreq·y) that is added to RTData. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1
ZFreq Natural frequency of the z wave, the ZFreq in ZMag·cos(ZFreq·z); z is the offset from Center divided by the extent width in z. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1
ZMag Amplitude of the z wave: the term ZMag·cos(ZFreq·z) that is added to RTData. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvWavelet"
}

pvWindBladereader#

Reads WindBlade/Firetec simulations (wind over terrain, turbines or wildfire spread) through an ASCII .wind file that describes the data files, grid sizes and variables, one data file per time step. Output port 0 is the wind field (structured grid), port 1 the turbine blades (an unstructured grid, when turbines are used) and port 2 the ground topology (structured grid); select a port with {"node": id, "port": n}.

Common mistakes and assumptions:

  • The native documentation lists the outputs in a different order and calls the blades polygonal data; ParaView's XML port order is Field (0), Blade (1), Ground (2), and the blade output (port 1) is a vtkUnstructuredGrid.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: WindBladereader. Identity: sources/WindBladeReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Filename ASCII .wind file describes locations of data files, grid sizes and variable deltas, time step sizes, whether topology is used, whether turbines are used, and type and order of data written to the files. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
PointArrays Variables written to the data files are described in the .wind file and are presented for selection. Only selected variables are loaded for a time step. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 3,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvWindBladereader",
  "options": {
    "Filename": "REPLACE_WITH_VALUE"
  }
}

pvWriteCGNSWriter#

Explicit-export writer for CGNS (.cgns), the CFD General Notation System read by many solvers, meshers and post-processors. It accepts structured grids, polygonal data, unstructured grids, or a multiblock containing these, and stores mesh and point/cell solution fields in one file, using HDF5 storage by default (UseHDF5) or the older ADF layout. Publication uses the semantic contract: ParaView re-reads the file and geometry plus every input point and cell field are compared, accepting changes in block structure, point identity, connectivity order and storage type. Use it to hand results to CGNS-based tools; use pvWriteXMLUnstructuredGridWriter or pvWriteXMLMultiBlockDataWriter when the data only needs to round-trip through VTK.

Common mistakes and assumptions:

  • Image and rectilinear grids are outside the documented input types; convert them to a structured or unstructured grid first.
  • ParaView notes that the CGNS writer may not support ghost levels; leave GhostLevel at 0.
  • Keep UseHDF5 true unless the receiving tool can only read ADF-based CGNS files.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: CGNSWriter. Identity: writers/CGNSWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseHDF5 When UseHDF5 is turned ON, the CGNS file will use HDF5 as the underlying file format. When turned OFF, the file will use ADF as the underlying file format. HDF5 is preferred and default. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "cgns"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteCGNSWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteCSVWriter#

Explicit-export writer that turns one dataset, composite dataset or table into delimited text (.csv, .txt or .tsv): one row per point, cell or table row and one column per array component, optionally with point coordinates (AddMetaData) and time columns. Use it to hand values to spreadsheets, pandas or R; mesh topology is not kept. Publication uses the table contract: Schemaxis re-reads the file and checks the row count and every input array of the written association within the export tolerance, accepting the loss of topology, coordinates and structure.

Common mistakes and assumptions:

  • Precision defaults to 5 significant digits; raise it (17 reproduces doubles exactly) or set an export tolerance, otherwise verification usually fails.
  • Verification covers one dataset or table: composite input is rejected with UNSUPPORTED_DATA_TYPE (merge it with pvMergeBlocks first). The verifier uses the FieldAssociation, FieldDelimiter, StringDelimiter and UseStringDelimiter that ParaView holds on the created writer, so a .tsv file is checked with the tab ParaView sets for it. Author FieldAssociation as ParaView's entry text, for example "Cell Data". When it is omitted, ParaView picks (and Schemaxis reads back) the first of Point, Cell, Vertex, Edge, Row then Field Data that has arrays and tuples, which is not always the points. Only "Point Data", "Cell Data" and (for tables) "Row Data" can be verified: "Field Data", "Vertex Data" or "Edge Data" is rejected at planning with UNSUPPORTED_ASSOCIATION, and "Row Data" for a non-table input fails verification with the same fault; a delimiter longer than one character gives UNSUPPORTED_DELIMITER.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the table comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with Precision 17 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: CSVWriter. Identity: writers/CSVWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AddMetaData It is possible for this filter to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is point-set) or structured coordinates etc. To enable this addition of extra information, turn this flag on. {"type":"boolean"} native initialisation / omitted false
AddTime When set, the writer will add a "Time" column to the generated file indicating the current dataset time, if any. {"type":"boolean"} native initialisation / omitted false
AddTimeStep When set, the writer will add a "TimeStep" column to the generated file indicating the current dataset time step, if any. {"type":"boolean"} native initialisation / omitted false
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldAssociation Attribute data that the writer turns into rows: one row per point, cell, vertex, edge or table row, or the field-data tuples. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDelimiter Used to set the delimiter character. This is hidden from the user and set automatically based on the file extension. An extension of .tsv will set the delimiter character to a tab. Otherwise a comma will be used as the delimiter. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Precision Number of digits vtkCSVWriter prints for floating-point values. With UseScientificNotation false (ParaView's default) it counts significant digits, so the default 5 writes 101325.7 as 1.0133e+05; with UseScientificNotation true it counts digits after the decimal point of the mantissa. Integer columns are not affected. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StringDelimiter Used to set the delimiter used for string data, if any, eg. double quotes("). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
UseScientificNotation When true, every floating-point value is written in scientific notation (101325.7 with Precision 5 becomes 1.01326e+05) and Precision counts decimals of the mantissa. When false, the general format switches between fixed and exponent notation and Precision counts significant digits. {"type":"boolean"} native initialisation / omitted false
UseStringDelimiter Used to enable StringDelimiter for string data. Enabled by default. Turn this off if you do not want quotes around the column headers. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "table",
  "extensions": [
    "csv",
    "txt",
    "tsv"
  ],
  "filenames": "managed output directory",
  "losses": [
    "topology",
    "coordinates",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteCSVWriter",
  "acceptLosses": [
    "topology",
    "coordinates",
    "structure"
  ]
}

pvWriteDataSetCSVWriter#

Legacy alias of pvWriteCSVWriter: ParaView keeps DataSetCSVWriter, a proxy derived from CSVWriter with the same class and settings, only for old state files and traces. It writes the same delimited text (one row per point, cell or table row, one column per component) and is verified the same way under the table contract. Prefer pvWriteCSVWriter in new documents.

Common mistakes and assumptions:

  • Precision defaults to 5 significant digits; raise it (17 reproduces doubles exactly) or set an export tolerance, otherwise verification usually fails.
  • Verification covers one dataset or table: composite input is rejected with UNSUPPORTED_DATA_TYPE (merge it with pvMergeBlocks first). The verifier uses the FieldAssociation, FieldDelimiter, StringDelimiter and UseStringDelimiter that ParaView holds on the created writer, so a .tsv file is checked with the tab ParaView sets for it. Author FieldAssociation as ParaView's entry text, for example "Cell Data". When it is omitted, ParaView picks (and Schemaxis reads back) the first of Point, Cell, Vertex, Edge, Row then Field Data that has arrays and tuples, which is not always the points. Only "Point Data", "Cell Data" and (for tables) "Row Data" can be verified: "Field Data", "Vertex Data" or "Edge Data" is rejected at planning with UNSUPPORTED_ASSOCIATION, and "Row Data" for a non-table input fails verification with the same fault; a delimiter longer than one character gives UNSUPPORTED_DELIMITER.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the table comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with Precision 17 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: DataSetCSVWriter. Identity: writers/DataSetCSVWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet","vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AddMetaData It is possible for this filter to add additional meta-data to the field data such as point coordinates (when point attributes are selected and input is point-set) or structured coordinates etc. To enable this addition of extra information, turn this flag on. {"type":"boolean"} native initialisation / omitted false
AddTime When set, the writer will add a "Time" column to the generated file indicating the current dataset time, if any. {"type":"boolean"} native initialisation / omitted false
AddTimeStep When set, the writer will add a "TimeStep" column to the generated file indicating the current dataset time step, if any. {"type":"boolean"} native initialisation / omitted false
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldAssociation Attribute data that the writer turns into rows: one row per point, cell, vertex, edge or table row, or the field-data tuples. Chosen by the ParaView entry text: "Point Data", "Cell Data", "Vertex Data", "Edge Data", "Row Data" or "Field Data". ParaView offers only the associations the connected input has (for example "Row Data" for a table), so a text it does not offer fails with NATIVE_DOMAIN_MISMATCH when the node is configured. {"type":"enum","values":["Point Data","Cell Data","Vertex Data","Edge Data","Row Data","Field Data"]} native initialisation / omitted "Point Data"
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDelimiter Used to set the delimiter character. This is hidden from the user and set automatically based on the file extension. An extension of .tsv will set the delimiter character to a tab. Otherwise a comma will be used as the delimiter. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Precision Number of digits vtkCSVWriter prints for floating-point values. With UseScientificNotation false (ParaView's default) it counts significant digits, so the default 5 writes 101325.7 as 1.0133e+05; with UseScientificNotation true it counts digits after the decimal point of the mantissa. Integer columns are not affected. {"minimum":0,"type":"integer"} native initialisation / omitted 0
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
StringDelimiter Used to set the delimiter used for string data, if any, eg. double quotes("). {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
UseScientificNotation When true, every floating-point value is written in scientific notation (101325.7 with Precision 5 becomes 1.01326e+05) and Precision counts decimals of the mantissa. When false, the general format switches between fixed and exponent notation and Precision counts significant digits. {"type":"boolean"} native initialisation / omitted false
UseStringDelimiter Used to enable StringDelimiter for string data. Enabled by default. Turn this off if you do not want quotes around the column headers. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "table",
  "extensions": [
    "csv",
    "txt",
    "tsv"
  ],
  "filenames": "managed output directory",
  "losses": [
    "topology",
    "coordinates",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteDataSetCSVWriter",
  "acceptLosses": [
    "topology",
    "coordinates",
    "structure"
  ]
}

pvWriteDataSetWriter#

Explicit-export writer for the legacy VTK format (.vtk), the original single-file VTK layout still read by ParaView, VisIt, many solver converters and simple scripts. It writes one non-composite dataset of any mesh type, a table or a graph, in binary by default or ASCII (FileType). Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match the input exactly. Prefer scene geometry or the VTK XML writers (pvWriteXMLUnstructuredGridWriter, pvWriteXMLPolyDataWriter, ...) for new work, and use this writer when a downstream tool reads only legacy .vtk files.

Common mistakes and assumptions:

  • Composite (multiblock) inputs are rejected; merge blocks with pvMergeBlocks or use pvWriteXMLMultiBlockDataWriter.
  • If exact verification of an ASCII file reports changed values, switch FileType back to Binary, which stores the values bit for bit.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: DataSetWriter. Identity: writers/DataSetWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileType The type for the data file (i.e. ascii or binary). {"type":"enum","values":["Ascii","Binary"]} native initialisation / omitted "Ascii"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtk"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteDataSetWriter"
}

pvWriteEnSightWriter#

Explicit-export writer for EnSight Gold, the case format read by Ansys EnSight and many CFD post-processors: a .case index, a binary .geo geometry file and one file per point or cell array. It accepts only a single, non-composite unstructured grid; cells are grouped into EnSight parts by an integer BlockId cell array when present, otherwise everything is part 1. Publication uses the semantic contract: the case is read back and geometry plus every input point and cell field are compared, accepting changes in structure, point identity, connectivity order and storage type. Use pvWriteXMLUnstructuredGridWriter for lossless VTK storage, or pvWriteCGNSWriter / pvWriteIOSSWriter for other solver formats.

Common mistakes and assumptions:

  • VTK names the case file data.0.case (0 is the process number); Schemaxis finds it automatically, but keep the .case, .geo and variable files together when moving them.
  • Only arrays with 1, 3, 6 or 9 components (scalar, vector, symmetric or full tensor) get a valid case-file entry, and pixel or voxel cells are skipped; remove such arrays with pvPassArrays and avoid grids built directly from image data, or verification fails.
  • Field-data arrays are not stored in EnSight, while semantic verification checks them; remove field data upstream if the input carries any.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: EnSightWriter. Identity: writers/EnSightWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "case"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteEnSightWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteExodusIIWriter#

Explicit-export writer that saves a dataset or composite dataset as an Exodus II file (.e, .g, .ex2 …), the finite-element results format of the SEACAS tools. vtkExodusIIWriter writes each leaf's cells as unstructured elements grouped into element blocks; when the input carries no Exodus metadata (it did not come from an Exodus reader) it creates one block per cell type. Publication uses the semantic contract: the file is reopened and mesh geometry and every input field are compared, while block structure, point identity, connectivity order and storage type may change. Use pvWriteIOSSWriter for the IOSS path, or VTK XML output when Exodus is not required.

Common mistakes and assumptions:

  • Without Exodus metadata VTK warns 'Attempting to proceed without metadata'; this is a warning, not a failure, and IgnoreMetaDataWarning silences it.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the semantic comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: ExodusIIWriter. Identity: writers/ExodusIIWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet","vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels. {"minimum":0,"type":"integer"} native initialisation / omitted 0
IgnoreMetaDataWarning In certain cases like Catalyst we know that metadata doesn't exist and we want to ignore that warning. {"type":"boolean"} native initialisation / omitted false
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "g",
    "e",
    "ex2",
    "ex2v2",
    "gen",
    "exoII",
    "exoii"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteExodusIIWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteGenericIOWriter#

Explicit-export writer that saves a multiblock of particle unstructured grids as one HACC GenericIO file (.gio), each block becoming one rank's data (vtkPGenericIOMultiBlockWriter). Point coordinates are written as double variables x, y, z, single-component point arrays keep their names and 3-component arrays become <name>_x, _y and _z; cells and connectivity are not stored. Schemaxis verifies it with the semantic comparison, accepting structure and storage changes.

Common mistakes and assumptions:

  • The default readback cannot set coordinate names; give readback {"operation": "pvGenericIOMultiBlockReader", "options": {"xAxis": "x", "yAxis": "y", "zAxis": "z", "PointArrayStatus": [...]}} as Schemaxis's qualification fixture does.
  • If the data already have point arrays named x, y or z, the coordinates are written as xx, yy or zz instead.
  • A small serial fixture passed (verification/2026-09-16-catalogue-expansion.json); ParaView marks the writer requires_mpi and larger or parallel data are unverified.

Native constructor: GenericIOWriter. Identity: writers/GenericIOWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "gio"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteGenericIOWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteHoudiniWriter#

Explicit-export writer for the ASCII Houdini geometry format (.geo, pre-version-12 PGEOMETRY V2), for taking surfaces into SideFX Houdini for effects or rendering. The input must be polygonal data; point arrays become point attributes, cell arrays primitive attributes, and triangle strips are split into triangles. Schemaxis verifies geometry only, with its own parser of the writer's exact grammar (vertices, lines, polygons, triangle strips, attribute brackets, and NPrims counting emitted triangles): points and primitives are compared with the triangulated input surface, accepting loss of fields, point identity, interior cells and structure. Use pvWritePOBJWriter or pvWritePSTLWriter for more widely read surface formats.

Common mistakes and assumptions:

  • Coordinates are written with 6 significant digits (vtkHoudiniPolyDataWriter.cxx:383-386), so a zero tolerance is rejected at planning (INVALID_TOLERANCE) and publication rejects a tolerance below half a unit in the sixth digit of the largest coordinate (TOLERANCE_BELOW_WRITER_PRECISION, which reports the minimum). A tolerance of 1e-6 suits coordinates below 1; scale it with the data.
  • Verification requires the geometry comparison. The Schemaxis parser reads exactly what the writer emits: vertices, lines, polygons and triangle strips (each strip triangle counts as one NPrims primitive) with attribute values in brackets ignored. A degenerate strip of fewer than 3 points corrupts the writer's own file and gives UNSUPPORTED_FORMAT; remove such cells upstream. Array selection is not needed to verify cell arrays.
  • A custom readback reader is rejected for this writer; the built-in parser is always used.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with a tolerance of 1e-6 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: HoudiniWriter. Identity: writers/HoudiniWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode In MPI runs where NumberOfIORanks is greater than 1 and less than the number of ranks, chooses how ranks are grouped to send data to the writing ranks. Contiguous forms consecutive groups (16 ranks, 3 writers: 0-5, 6-10, 11-15, written by ranks 0, 6 and 11); RoundRobin interleaves them (0, 3, ..., 15; 1, 4, ..., 13; 2, 5, ..., 14, written by 0, 1 and 2). Schemaxis runs explicit exports serially, so this has no effect on the file. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "geometry",
  "extensions": [
    "geo"
  ],
  "filenames": "managed output directory",
  "losses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteHoudiniWriter",
  "acceptLosses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ]
}

pvWriteHyperTreeGridWriter#

Explicit-export writer for VTK's hyper tree grid XML format (.htg), which stores adaptive tree-based meshes (vtkHyperTreeGrid: a coarse grid of quadtrees or octrees) with their refinement trees, masks, coordinates and cell fields. The input must be one non-composite hyper tree grid; all its arrays are written. Publication uses the exact contract: ParaView re-reads the file and tree structure, masks, coordinates and cell arrays must match exactly. Use pvWriteSerialHTGMultiBlock for a multiblock of hyper tree grids; this is also the format scene geometry chooses for hyper tree grids.

Common mistakes and assumptions:

  • Few tools outside VTK and ParaView read .htg; convert the data to an unstructured grid upstream when the receiver needs a conventional mesh.
  • Ascii DataMode is mainly for inspection and gives much larger files than Appended.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: HyperTreeGridWriter. Identity: writers/HyperTreeGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "htg"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteHyperTreeGridWriter"
}

pvWriteIOSSWriter#

Explicit-export writer for Exodus II (.exo) through the IOSS library, the finite-element format of Sandia's SIERRA codes, Cubit and many structural and multiphysics solvers. It accepts a dataset, a partitioned dataset or a partitioned dataset collection; every partition becomes an element block unless selectors (or, for data read by ParaView's IOSS reader, its IOSS assembly) assign partitions to blocks and sets, and a time-dependent input is exported for the one scheduled time step: Schemaxis manages TimeStepRange and TimeStepStride, because the writer otherwise loops over every input time step itself. Publication uses the semantic contract: the file is re-read and geometry plus every input point and cell field are compared, accepting loss of structure, point identity, connectivity order and storage type. Use pvWriteExodusIIWriter for ParaView's older Exodus writer and pvWriteCGNSWriter for CGNS tools.

Common mistakes and assumptions:

  • Exodus ids start at 1. For time-dependent input, ParaView 5.13.3's IOSS writer aborts the whole run when the point global ids start at 0 or are absent (native pvbatch probe, 2026-10-12), so Schemaxis refuses such an export before writing (UNSUPPORTED_INPUT): add ids with pvGlobalPointAndCellIds and set OffsetGlobalIds true, which the probe confirmed writes the scheduled step. Static input is written either way.
  • vtkIOSSWriter runs its own time loop and ignores the scheduled time (vtkIOSSWriter.cxx:285-342). A native pvbatch 5.13.3 probe found that on creation ParaView replaces the static TimeStepRange [0, 1] with the domain range [0, n-1], and a default export wrote all steps for one scheduled time. When the exported node reports two or more time steps (read from its pipeline information, so filters count too), Schemaxis sets TimeStepRange [k, k+1] and TimeStepStride 2 for the scheduled step k (probe: exactly one step, whose Point Value matched step k, for k = 0, 2 and 9); both settings are managed and cannot be authored, and a scheduled time that is not one of the input steps gives TIME_NOT_IN_INPUT. The probe did not establish the time stamp stored in the file, so do not rely on it.
  • ParaView's GUI-only entity-type chooser (EntityType, which has no native command) is not exposed; select blocks and arrays with the *Selectors and *Arrays settings.
  • Semantic readback compares every input point and cell array by name. Exodus stores global ids as maps rather than fields, and readers may merge arrays whose names end in X, Y and Z into one vector, so inputs carrying such arrays (for example GlobalPointIds, or Point X/Y/Z) fail verification with 'semantic readback lacks an input field'; pass only the arrays you need with pvPassArrays before exporting.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: IOSSWriter. Identity: writers/IOSSWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPartitionedDataSetCollection","vtkPartitionedDataSet","vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specify selectors to choose blocks to write. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
ChooseArraysToWrite Property to control whether to choose arrays to write. {"type":"boolean"} native initialisation / omitted false
DisplacementMagnitude If input dataset has displacements pre-applied, setting the displacement magnitude to non-zero ensures that the point coordinates in the dataset are correctly transformed using the displacement field array, if present. {"minimum":0.0,"type":"number"} native initialisation / omitted 0.0
EdgeBlockArrays Select the edge block arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeBlockSelectors Specify the edge block selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetArrays Select the edge set arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EdgeSetSelectors Specify the edge sets selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlockArrays Select the element block arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementBlockSelectors Specify the element block selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetArrays Select the element set arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ElementSetSelectors Specify the element sets selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlockArrays Select the face block arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceBlockSelectors Specify the face block selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetArrays Select the face set arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FaceSetSelectors Specify the face sets selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeBlockArrays Select the node block arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetArrays Select the node set arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NodeSetSelectors Specify the node sets selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
OffsetGlobalIds Exodus wants global ids to start with 1, while VTK generally produces global ids starting with 0. Set this to true (default false), if the global ids are generated by VTK and hence start with 0. When writing to the output file, they will be offset by 1 to ensure the ids are valid exodus ids. {"type":"boolean"} native initialisation / omitted false
PreserveOriginalIds If input is transformed, e.g. through clipping, new element blocks may be created. This flag can be used to indicate whether to preserve the original ids from blocks or not. {"type":"boolean"} native initialisation / omitted false
RemoveGhosts Property to control whether to remove ghost cells from the input or not. {"type":"boolean"} native initialisation / omitted false
SideSetArrays Select the side set arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SideSetSelectors Specify the side sets selectors for the data assembly chosen using Assembly to choose the blocks to write from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteQAAndInformationRecords When checked, the writer will write quality assurance and information records, if available. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "exo"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "ChoosetheoutputblocksarraysfortheExodusEntityType": "no native command (GUI-only property)"
  },
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteIOSSWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteJPEGWriter#

Explicit-export writer that saves image data (vtkImageData) as a JPEG (.jpg) file: 1 to 3 components of unsigned char values, compressed lossily at VTK's quality 95. Publication uses the pixels contract, comparing dimensions, components and values after re-reading, so a positive export tolerance is required (zero is rejected at planning) and pvWritePNGWriter is the choice for exact pixels.

Common mistakes and assumptions:

  • A tolerance of 0 is rejected at planning (INVALID_TOLERANCE) because JPEG compression changes values; choose a tolerance in the 0 to 255 value range or export PNG. Verification also requires the pixels comparison.
  • VTK's writer accepts only unsigned char (8-bit) scalars (vtkJPEGWriter.cxx:219-223); other scalar types, or an image without active scalars, fail before writing with UNSUPPORTED_DATA_TYPE. Convert upstream, because Schemaxis performs no implicit conversion.
  • Schemaxis manages the file name, so export 2-D images; a numbered 3-D stack needs a file pattern.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with a pixel tolerance of 3 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: JPEGWriter. Identity: writers/JPEGWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Output publication contract:

{
  "comparison": "pixels",
  "extensions": [
    "jpg"
  ],
  "filenames": "managed output directory",
  "losses": [
    "coordinates",
    "fields"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteJPEGWriter",
  "acceptLosses": [
    "coordinates",
    "fields"
  ]
}

pvWriteJSONImageWriter#

Explicit-export writer that saves a uniform image (vtkImageData) node as a JSON document listing the image dimensions, origin, spacing and the values of its point arrays, for web or scripting tools rather than for re-reading in ParaView. Use it as an export writer with comparison "pixels": Schemaxis then parses the JSON itself and checks dimensions, origin, spacing and exactly the arrays the writer emits against the source image: one-component point arrays other than vtkValidPointMask, narrowed by ArrayName and Slice, with null where vtkValidPointMask is 0. The input must be non-composite image data; resample other datasets to an image first. For standard raster formats use pvWritePNGWriter, pvWriteTIFFWriter or pvWriteMetaImageWriter.

Common mistakes and assumptions:

  • ArrayName and Slice are honoured by the verifier: ArrayName must name a one-component point array (otherwise nothing is written and verification fails), and Slice must be -1 or below the image depth (a larger Slice is rejected with INVALID_SLICE before writing, because VTK does not bound-check it). Vector arrays and vtkValidPointMask are never written.
  • The writer prints values, origin and spacing with 6 significant digits (VTK vtkVariant::ToString precision 6), so floating-point data usually needs a positive tolerance.
  • Only pixels comparison is accepted and a custom readback reader is rejected for this writer.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: JSONImageWriter. Identity: writers/JSONImageWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ArrayName The name of the field to export. If Empty all fields will be saved. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Slice Write only one slice if slice >= 0 {"minimum":-1,"type":"integer"} native initialisation / omitted -1

Output publication contract:

{
  "comparison": "pixels",
  "extensions": [
    "json"
  ],
  "filenames": "managed output directory",
  "losses": [
    "coordinates",
    "fields"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteJSONImageWriter",
  "acceptLosses": [
    "coordinates",
    "fields"
  ]
}

pvWriteMetaImageWriter#

Explicit-export writer for MetaImage (.mhd): a short text header (dimensions, spacing, element type) plus a separate binary data file, the format read by ITK-based medical-imaging and segmentation tools. The input must be one non-composite vtkImageData; VTK writes the image scalars and compresses the data file by default. Schemaxis publishes it under the pixels contract: the file is read back and dimensions, component count and scalar values are compared, while coordinates and other fields are accepted as lost. Use pvWriteTIFFWriter or pvWritePNGWriter for 2-D raster interchange, or automatic VTK XML image output (.vti) to keep all arrays.

Common mistakes and assumptions:

  • Only the image scalars are carried; make the array you need the active point scalars, or export VTK XML image data when several arrays matter.
  • Keep the header and its data file together when moving the result; the header refers to the data file by name.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: MetaImageWriter. Identity: writers/MetaImageWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Output publication contract:

{
  "comparison": "pixels",
  "extensions": [
    "mhd"
  ],
  "filenames": "managed output directory",
  "losses": [
    "coordinates",
    "fields"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteMetaImageWriter",
  "acceptLosses": [
    "coordinates",
    "fields"
  ]
}

pvWriteOpenVDBWriter#

Explicit-export writer for OpenVDB (.vdb), the sparse volume format used by Houdini, Blender and film-style renderers. It accepts non-composite image data (volumes) or point sets (meshes or point clouds handled through their points); with EnableColoring it adds a colour channel, and with EnableAlpha an alpha channel, computed from a lookup table supplied through the export's LookupTable resource. The declared publication uses the exact contract, comparing ParaView's readback of the .vdb with the input. Use it to send simulation volumes to rendering tools; keep pvWriteXMLImageDataWriter for lossless analysis data.

Common mistakes and assumptions:

  • An earlier Schemaxis catalogue check of this writer failed because the readback differed from the input; expect exact verification to fail and set a comparison and accepted losses that match what VDB keeps.
  • EnableColoring needs a lookup table connected through resources (LookupTable) and the array to map named in ColorArrayName; otherwise no colour channel can be computed.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) failed on a small serial fixture with default options: the readback differed from the input; no current native acceptance check is recorded, so verify the file in the receiving tool.

Native constructor: OpenVDBWriter. Identity: writers/OpenVDBWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData","vtkPointSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
LookupTable Connect upstream object to LookupTable False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ColorArrayName The array that will be used for saving color information when Enable Coloring is ON. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EnableAlpha Specify whether alpha channel information should be saved in the VDB file. If enabled, the data source's transfer function from the active view will be used. This property is disabled if EnableColoring isn't enabled. {"type":"boolean"} native initialisation / omitted false
EnableColoring Specify whether color information should be saved in the VDB file. If enabled, the data source's array to color with from the active view will be used. {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vdb"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {
    "DummyInput": "domain-only input (no native command)"
  },
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteOpenVDBWriter"
}

pvWritePDataSetWriterPolyData#

Legacy VTK (.vtk) writer for polygonal data built on ParaView's parallel-serial writer, which in an MPI run gathers all pieces to one or a few ranks (NumberOfIORanks) and writes a single file. Schemaxis runs explicit exports serially, so the result is the same single binary-by-default legacy file that pvWriteDataSetWriter produces for a polydata. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match exactly. Prefer pvWriteDataSetWriter, which accepts any dataset type, or pvWriteXMLPolyDataWriter for the modern XML format.

Common mistakes and assumptions:

  • NumberOfIORanks and RankAssignmentMode change nothing here, because documents with explicit exports are rejected for MPI execution.
  • If exact verification of an ASCII file reports changed values, switch FileType back to Binary.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: PDataSetWriterPolyData. Identity: writers/PDataSetWriterPolyData. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileType The type for the data file (i.e. ascii or binary). {"type":"enum","values":["Ascii","Binary"]} native initialisation / omitted "Ascii"
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode In MPI runs where NumberOfIORanks is greater than 1 and less than the number of ranks, chooses how ranks are grouped to send data to the writing ranks. Contiguous forms consecutive groups (16 ranks, 3 writers: 0-5, 6-10, 11-15, written by ranks 0, 6 and 11); RoundRobin interleaves them (0, 3, ..., 15; 1, 4, ..., 13; 2, 5, ..., 14, written by 0, 1 and 2). Schemaxis runs explicit exports serially, so this has no effect on the file. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtk"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePDataSetWriterPolyData"
}

pvWritePDataSetWriterUnstructuredGrid#

Legacy VTK (.vtk) writer for unstructured grids built on ParaView's parallel-serial writer, which in an MPI run gathers all pieces to one or a few ranks (NumberOfIORanks) and writes a single file. Schemaxis runs explicit exports serially, so the result is the same single binary-by-default legacy file that pvWriteDataSetWriter produces for a unstructured grid. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match exactly. Prefer pvWriteDataSetWriter, which accepts any dataset type, or pvWriteXMLUnstructuredGridWriter for the modern XML format.

Common mistakes and assumptions:

  • NumberOfIORanks and RankAssignmentMode change nothing here, because documents with explicit exports are rejected for MPI execution.
  • If exact verification of an ASCII file reports changed values, switch FileType back to Binary.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: PDataSetWriterUnstructuredGrid. Identity: writers/PDataSetWriterUnstructuredGrid. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileType The type for the data file (i.e. ascii or binary). {"type":"enum","values":["Ascii","Binary"]} native initialisation / omitted "Ascii"
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode In MPI runs where NumberOfIORanks is greater than 1 and less than the number of ranks, chooses how ranks are grouped to send data to the writing ranks. Contiguous forms consecutive groups (16 ranks, 3 writers: 0-5, 6-10, 11-15, written by ranks 0, 6 and 11); RoundRobin interleaves them (0, 3, ..., 15; 1, 4, ..., 13; 2, 5, ..., 14, written by 0, 1 and 2). Schemaxis runs explicit exports serially, so this has no effect on the file. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtk"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePDataSetWriterUnstructuredGrid"
}

pvWritePNGWriter#

Explicit-export writer that stores image data (vtkImageData) as PNG, a lossless raster format holding 1 to 4 components of unsigned char (8-bit) or unsigned short (16-bit) values. It suits masks, label images and already-quantized images, not floating-point simulation fields; this writes data values, unlike a rendered scene image. Publication uses the pixels contract: the PNG is read back and its dimensions, components and values are compared with the input scalars. Use pvWriteTIFFWriter for 32-bit float data.

Common mistakes and assumptions:

  • Float or double arrays are not supported; rescale and convert them to 8- or 16-bit integers upstream, because Schemaxis performs no implicit conversion.
  • Natively a 3-D image can be written as a numbered slice stack through a file pattern, but Schemaxis manages the file name, so export 2-D images.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: PNGWriter. Identity: writers/PNGWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Output publication contract:

{
  "comparison": "pixels",
  "extensions": [
    "png"
  ],
  "filenames": "managed output directory",
  "losses": [
    "coordinates",
    "fields"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePNGWriter",
  "acceptLosses": [
    "coordinates",
    "fields"
  ]
}

pvWritePOBJWriter#

Explicit-export writer for Wavefront OBJ (.obj), a plain-text surface format read by almost every 3-D modelling, rendering and visualization tool. It writes the points, lines, triangles and polygons of polygonal data plus point normals and texture coordinates when present; solution fields are not stored. TextureFileName additionally writes a material (.mtl) file that refers to an existing texture image. Publication uses the geometry contract: the file is read back and the triangulated surface is compared, accepting loss of fields, point identity, interior cells and structure. Use pvWritePSTLWriter for triangle-only CAD or 3-D printing exchange, and VTK XML writers when fields matter.

Common mistakes and assumptions:

  • Scalar and vector fields (pressure, velocity, ...) are lost; export a VTK XML format when the receiver needs them.
  • TextureFileName is written into the .mtl as given and the image is not copied into the output folder; use a path that still resolves where the OBJ will be opened.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with a tolerance of 1e-6 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: POBJWriter. Identity: writers/POBJWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode In MPI runs where NumberOfIORanks is greater than 1 and less than the number of ranks, chooses how ranks are grouped to send data to the writing ranks. Contiguous forms consecutive groups (16 ranks, 3 writers: 0-5, 6-10, 11-15, written by ranks 0, 6 and 11); RoundRobin interleaves them (0, 3, ..., 15; 1, 4, ..., 13; 2, 5, ..., 14, written by 0, 1 and 2). Schemaxis runs explicit exports serially, so this has no effect on the file. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TextureFileName Optional. The name of the texture map file to be written into the mtl file. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "geometry",
  "extensions": [
    "obj"
  ],
  "filenames": "managed output directory",
  "losses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePOBJWriter",
  "acceptLosses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ]
}

pvWritePPLYWriter#

Explicit-export writer for Stanford PLY (.ply): polygonal surface geometry (points and polygons) for mesh, 3-D printing and point-cloud tools, binary by default (FileType). It accepts polygonal data only, so extract a surface first (pvExtractSurface). Field arrays are not carried, except optional per-point or per-cell RGB(A) colours written when EnableColoring is true, ColorArrayName names the array and a lookup-table resource is attached to the export. Publication uses the geometry contract: Schemaxis re-reads the file with ParaView's PLY reader and compares the triangulated surface within the tolerance.

Common mistakes and assumptions:

  • Colours need all three: EnableColoring true, ColorArrayName and a LookupTable resource in the export's resources; otherwise the writer writes geometry only.
  • With ChooseArraysToWrite true, keep the colour array in the lists or no colours are written; the geometry comparison accepts the dropped fields, so array selection stays available here.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with a tolerance of 1e-6 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: PPLYWriter. Identity: writers/PPLYWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
LookupTable Connect upstream object to LookupTable False one object lookup-table {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ColorArrayName The array that will be used for saving color information when Enable Coloring is ON. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EnableAlpha Specify whether alpha channel information should be saved in the PLY file. If enabled, the data source's transfer function from the active view will be used. This property is disabled if EnableColoring isn't enabled. {"type":"boolean"} native initialisation / omitted false
EnableColoring When true, the writer maps the array named in ColorArrayName through the lookup table attached as the export's LookupTable resource and stores the resulting RGB colours per point or per cell in the PLY file. Without both the array and the lookup table it writes geometry only. {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileType The type for the data file (i.e. ascii or binary). {"type":"enum","values":["Ascii","Binary"]} native initialisation / omitted "Ascii"
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode When NumberOfIORanks is greater than 1 and less than the number of MPI ranks, this controls how the ranks that write to disk are determined. This also affects which ranks send data to which rank for IO. In Contiguous mode (default), all MPI ranks are numerically grouped into NumberOfIORanks groups with the first rank in each group acting as the root node for that group and is the one that does IO. For example, if there are 16 MPI ranks and NumberOfIORanks is set to 3 then the groups are [0 - 5], [6 - 10], [11 - 15] with the first rank in each group 0, 6, and 15 doing the IO. In RoundRobin mode, the grouping is done in round robin fashion, thus for 16 MPI ranks with NumberOfIORanks set to 3, the groups are [0, 3, ..., 15], [1, 4, ..., 13], [2, 5, ..., 14] with 0, 1 and 2 doing the IO. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "geometry",
  "extensions": [
    "ply"
  ],
  "filenames": "managed output directory",
  "losses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePPLYWriter",
  "acceptLosses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ]
}

pvWritePSTLWriter#

Explicit-export writer for STL (.stl), the triangle-only surface format used by 3-D printing, CAD and meshing tools (for example as snappyHexMesh geometry). It writes binary STL by default or ASCII with FileType; only triangles are stored, with no units or fields. Publication uses the geometry contract: the file is re-read and its triangles are compared with the triangulated input surface within the tolerance, accepting loss of fields, point identity, interior cells and structure. Use pvWritePOBJWriter to keep polygons and normals, or pvWritePPLYWriter for per-vertex attributes.

Common mistakes and assumptions:

  • Lines and vertex cells are not written to STL, so an input that contains them fails the geometry verification (Schemaxis compares the triangulated input, which keeps them); extract the surface (pvExtractSurface) and keep only polygons before exporting. Polygons with more than three vertices are triangulated by vtkSTLWriter itself; the ParaView help text about writing only their first three vertices is out of date.
  • Binary STL stores coordinates as 32-bit floats; give a small tolerance (the guide's example uses 0.000001) when the input uses double precision.
  • STL carries no length unit; check millimetres versus metres in the receiving tool.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with a tolerance of 1e-6 and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: PSTLWriter. Identity: writers/PSTLWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileType The type for the data file (i.e. ascii or binary). {"type":"enum","values":["Ascii","Binary"]} native initialisation / omitted "Ascii"
NumberOfIORanks In parallel runs, this writer can consolidate output from multiple ranks to a subset of ranks. This specifies the number of ranks that will do the final writing to disk. If NumberOfIORanks is 0, then all ranks will save the local data. If set to 1 (default), the root node alone will write to disk. All data from all ranks will be gathered to the root node before being written out. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RankAssignmentMode In MPI runs where NumberOfIORanks is greater than 1 and less than the number of ranks, chooses how ranks are grouped to send data to the writing ranks. Contiguous forms consecutive groups (16 ranks, 3 writers: 0-5, 6-10, 11-15, written by ranks 0, 6 and 11); RoundRobin interleaves them (0, 3, ..., 15; 1, 4, ..., 13; 2, 5, ..., 14, written by 0, 1 and 2). Schemaxis runs explicit exports serially, so this has no effect on the file. {"type":"enum","values":["Contiguous","RoundRobin"]} native initialisation / omitted "Contiguous"
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "geometry",
  "extensions": [
    "stl"
  ],
  "filenames": "managed output directory",
  "losses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWritePSTLWriter",
  "acceptLosses": [
    "fields",
    "point-identity",
    "interior-cells",
    "structure"
  ]
}

pvWriteSerialHTGMultiBlock#

Explicit-export writer that saves a multiblock dataset whose blocks are hyper tree grids as a VTK multiblock file (.vtm) plus one .htg file per block in a data/ subfolder. ParaView marks its input as composite-only (the input contract records composite as "required"): the node must output a multiblock of hyper tree grids. Publication uses the exact contract: ParaView re-reads the .vtm and the block structure, trees and cell arrays must match exactly. Use pvWriteHyperTreeGridWriter for a single hyper tree grid.

Common mistakes and assumptions:

  • A single, non-composite hyper tree grid fails the input check; group grids first (for example with pvGroupDatasets) or use pvWriteHyperTreeGridWriter.
  • Keep the .vtm and its data/ folder together; the .vtm refers to the pieces by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: SerialHTGMultiBlock. Identity: writers/SerialHTGMultiBlock. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":"required","cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtm"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteSerialHTGMultiBlock"
}

pvWriteTIFFWriter#

Explicit-export writer that saves image data (vtkImageData) as TIFF. vtkTIFFWriter accepts unsigned char, unsigned short or float scalars, so unlike PNG it can store 32-bit floating-point fields such as a sampled temperature image. Scalars selects which point array becomes the image values. Publication uses the pixels contract: the TIFF is read back and dimensions, components and values are compared; coordinates and other arrays are not preserved.

Common mistakes and assumptions:

  • Double-precision and other integer types are rejected by the native writer; convert the array to float (or 8/16-bit unsigned) upstream.
  • Name the array in Scalars; otherwise ParaView decides which array is written.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) failed on a small serial fixture with default options: pixel values changed beyond tolerance (tolerance 0); no current native acceptance check is recorded, so verify the file in the receiving tool.

Native constructor: TIFFWriter. Identity: writers/TIFFWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Scalars This property contains the name of the scalar array to be saved. {"items":{"type":"string"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "pixels",
  "extensions": [
    "tiff"
  ],
  "filenames": "managed output directory",
  "losses": [
    "coordinates",
    "fields"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteTIFFWriter",
  "acceptLosses": [
    "coordinates",
    "fields"
  ]
}

pvWriteVTKHDFWriter#

Explicit-export writer for VTKHDF (.vtkhdf), VTK's HDF5-based single-file format, suited to large meshes and to parallel or partial reading. In ParaView 5.13.3 it accepts unstructured grids, polygonal data, partitioned dataset collections and multiblock datasets. Publication uses the exact contract: ParaView re-reads the file and structure, connectivity, values and storage types must match the input exactly. Use it for compact archives of large meshes; the VTK XML writers (for example pvWriteXMLUnstructuredGridWriter) remain the most widely supported VTK format.

Common mistakes and assumptions:

  • Image, structured and rectilinear grids are not accepted; use the matching XML writer or convert the data first.
  • Higher CompressionLevel values shrink the file but make writing and reading noticeably slower.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: VTKHDFWriter. Identity: writers/VTKHDFWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid","vtkPolyData","vtkPartitionedDataSetCollection","vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ChunkSize Chunk Size controls the size of HDF5 datasets chunks. Chunk size can impact multi-process reading performance and compression efficiency. {"type":"integer"} native initialisation / omitted 1
CompressionLevel Compression level controls how much user wants to compress the written data. Using a higher level of compression will decrease file size but significantly slow down read and write operations. {"maximum":9,"minimum":0,"type":"integer"} native initialisation / omitted 0

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtkhdf"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteVTKHDFWriter"
}

pvWriteXMLHierarchicalBoxDataWriter#

Deprecated ParaView name for the VTK XML AMR writer: it saves overlapping AMR data (vtkHierarchicalBoxDataSet, i.e. refinement levels of uniform image blocks) as a .vthb index plus one .vti file per block in a data/ subfolder. ParaView 5.13.3 marks it deprecated in favour of pvWriteXMLUniformGridAMRWriter, which takes the same settings and is the better choice for new documents. Publication uses the exact contract: ParaView re-reads the .vthb (Schemaxis requests every level) and levels, boxes, origins and arrays must match exactly.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node. ChooseBlocksToWrite true is rejected at planning (BLOCK_SELECTION_UNVERIFIABLE) because no comparison accepts missing blocks; extract the blocks to keep with pvExtractBlock and export that node.
  • Keep the .vthb and its data/ folder together; the index refers to the blocks by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLHierarchicalBoxDataWriter. Identity: writers/XMLHierarchicalBoxDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUniformGridAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specifying selectors to choose blocks to extract. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ChooseBlocksToWrite Explicitly choose which blocks to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Selectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vthb"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLHierarchicalBoxDataWriter"
}

pvWriteXMLImageDataWriter#

Explicit-export writer for VTK XML image data (.vti): a uniform grid (origin, spacing, dimensions, direction) with all point, cell and field arrays, stored losslessly in one file. Scene geometry already chooses this format automatically for image data; use this writer for explicit DataMode or compression control or several exports of one node. Publication uses the exact contract: ParaView re-reads the file and extent, origin, spacing, direction and every array must match exactly. Use pvWriteXMLPImageDataWriter for the parallel .pvti layout, and pvWriteTIFFWriter or pvWritePNGWriter for raster interchange.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLImageDataWriter. Identity: writers/XMLImageDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vti"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLImageDataWriter"
}

pvWriteXMLMultiBlockDataWriter#

Explicit-export writer for VTK XML multiblock data (.vtm): an index describing the block tree (names and nesting) plus one VTK XML file per leaf dataset in a data/ subfolder, keeping every array. Scene geometry uses the same format automatically for multiblock outputs; choose this writer for explicit storage settings or block selection. Publication uses the exact contract: ParaView re-reads the .vtm and block structure, names, geometry and arrays must match exactly. Use pvWriteXMLPartitionedDataSetCollectionWriter for partitioned collections and pvWriteIOSSWriter or pvWriteCGNSWriter for solver interchange.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node. ChooseBlocksToWrite true is rejected at planning (BLOCK_SELECTION_UNVERIFIABLE) because no comparison accepts missing blocks; extract the blocks to keep with pvExtractBlock and export that node.
  • Keep the .vtm and its data/ folder together; the index refers to the pieces by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLMultiBlockDataWriter. Identity: writers/XMLMultiBlockDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkMultiBlockDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specifying selectors to choose blocks to extract. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ChooseBlocksToWrite Explicitly choose which blocks to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Selectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtm"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLMultiBlockDataWriter"
}

pvWriteXMLPHyperTreeGridWriter#

Parallel-layout writer for hyper tree grids: a .phtg summary file that lists one .htg piece per process. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the summary and trees, masks and cell arrays must match exactly. Prefer pvWriteHyperTreeGridWriter, which writes the same data as one self-contained .htg file.

Common mistakes and assumptions:

  • ParaView 5.13.3 completes the write (a .phtg summary plus a piece .htg file), but its XMLPHyperTreeGridReader crashes with a segmentation fault when it opens the .phtg, while the HyperTreeGridReader (pvHyperTreeGridReader), which ParaView picks for a piece .htg, reads the piece. Schemaxis verifies an export by reading it back, so exporting through this writer crashes the native process at readback (a bounded native probe, 2026-10-12, reproduced it in a separate process from the write, opening the file with OpenDataFile as publish does without a readback override); use pvWriteHyperTreeGridWriter unless you specifically need the .phtg layout.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) failed on a small serial fixture with WriteTimeValue false and the other options at their defaults: ParaView crashed with a segmentation fault; no current native acceptance check is recorded, so verify the file in the receiving tool.

Native constructor: XMLPHyperTreeGridWriter. Identity: writers/XMLPHyperTreeGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "phtg"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPHyperTreeGridWriter"
}

pvWriteXMLPImageDataWriter#

Explicit-export writer for the parallel VTK XML layout of image data (uniform grids with origin, spacing and extent): a small .pvti summary file listing one .vti piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvti and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvti layout; otherwise pvWriteXMLImageDataWriter or scene geometry gives one self-contained .vti file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvti file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPImageDataWriter. Identity: writers/XMLPImageDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkImageData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvti"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPImageDataWriter"
}

pvWriteXMLPPartitionedDataSetWriter#

Explicit-export writer for VTK XML partitioned datasets (.vtpd): an index plus one VTK XML file per partition (each partition a dataset of its own type) in a data/ subfolder, keeping every partition's geometry and arrays. Scene geometry uses the same format automatically for partitioned datasets; choose this writer for explicit storage settings. Publication uses the exact contract: ParaView re-reads the .vtpd and partitions, geometry and arrays must match exactly. Use pvWriteXMLPartitionedDataSetCollectionWriter for collections of partitioned datasets and pvWriteXMLMultiBlockDataWriter for multiblock data.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .vtpd and its data/ folder together; the index refers to the pieces by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPPartitionedDataSetWriter. Identity: writers/XMLPPartitionedDataSetWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPartitionedDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtpd"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPPartitionedDataSetWriter"
}

pvWriteXMLPPolyDataWriter#

Explicit-export writer for the parallel VTK XML layout of polygonal data (surfaces, lines and points): a small .pvtp summary file listing one .vtp piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtp and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtp layout; otherwise pvWriteXMLPolyDataWriter or scene geometry gives one self-contained .vtp file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvtp file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPPolyDataWriter. Identity: writers/XMLPPolyDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). {"type":"integer"} native initialisation / omitted 1
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseSubdirectory Where the .vtp piece files go: true stores them in a subfolder named after the summary file without its extension (data/ for Schemaxis's managed name data.pvtp); false puts them directly beside data.pvtp. Only the file layout and the relative paths inside the summary change, not the data, so verification is unaffected; both layouts stay inside the export's managed output folder. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvtp"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPPolyDataWriter"
}

pvWriteXMLPRectilinearGridWriter#

Explicit-export writer for the parallel VTK XML layout of rectilinear grids (axis-aligned grids with separate x, y and z coordinate arrays): a small .pvtr summary file listing one .vtr piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtr and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtr layout; otherwise pvWriteXMLRectilinearGridWriter or scene geometry gives one self-contained .vtr file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvtr file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPRectilinearGridWriter. Identity: writers/XMLPRectilinearGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvtr"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPRectilinearGridWriter"
}

pvWriteXMLPStructuredGridWriter#

Explicit-export writer for the parallel VTK XML layout of structured grids (curvilinear i-j-k grids with explicit point coordinates): a small .pvts summary file listing one .vts piece per process, stored in a data/ subfolder. Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvts and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvts layout; otherwise pvWriteXMLStructuredGridWriter or scene geometry gives one self-contained .vts file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvts file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPStructuredGridWriter. Identity: writers/XMLPStructuredGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvts"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPStructuredGridWriter"
}

pvWriteXMLPTableWriter#

Explicit-export writer for the parallel VTK XML layout of tables (rows of named columns): a small .pvtt summary file listing one .vtt piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtt and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtt layout; otherwise pvWriteXMLTableWriter or scene geometry gives one self-contained .vtt file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvtt file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPTableWriter. Identity: writers/XMLPTableWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseSubdirectory Where the .vtt piece files go: true stores them in a subfolder named after the summary file without its extension (data/ for Schemaxis's managed name data.pvtt); false puts them directly beside data.pvtt. Only the file layout and the relative paths inside the summary change, not the data, so verification is unaffected; both layouts stay inside the export's managed output folder. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvtt"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPTableWriter"
}

pvWriteXMLPUnstructuredGridWriter#

Explicit-export writer for the parallel VTK XML layout of unstructured grids (meshes of arbitrary cell types): a small .pvtu summary file listing one .vtu piece per process, stored in a data/ subfolder by default (UseSubdirectory). Schemaxis runs explicit exports serially, so the result is one piece; choosing a parallel writer does not launch MPI. Publication uses the exact contract: ParaView re-reads the .pvtu and structure, values and storage types must match the input exactly. Use it when a downstream tool expects the .pvtu layout; otherwise pvWriteXMLUnstructuredGridWriter or scene geometry gives one self-contained .vtu file.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .pvtu file and its piece files together; the summary refers to them by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPUnstructuredGridWriter. Identity: writers/XMLPUnstructuredGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). {"type":"integer"} native initialisation / omitted 1
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
UseSubdirectory Where the .vtu piece files go: true stores them in a subfolder named after the summary file without its extension (data/ for Schemaxis's managed name data.pvtu); false puts them directly beside data.pvtu. Only the file layout and the relative paths inside the summary change, not the data, so verification is unaffected; both layouts stay inside the export's managed output folder. {"type":"boolean"} native initialisation / omitted false
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvtu"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPUnstructuredGridWriter"
}

pvWriteXMLPVDWriter#

Explicit-export writer for ParaView's PVD format: a small XML .pvd index plus the VTK XML piece file(s) it references (type chosen from the data, e.g. .vtu or .vtp), written into a subdirectory named after the file, for one time step. It accepts a single non-composite dataset or table. Publication uses the exact contract: the .pvd is reopened and structure, connectivity, values and storage types must match the input. Choose it when the recipient expects a .pvd collection; otherwise a single-file pvWriteXML…Writer is simpler.

Common mistakes and assumptions:

  • Composite (multiblock) inputs are rejected; use pvWriteXMLMultiBlockDataWriter for those.
  • Keep the .pvd and its subdirectory together; the index refers to the piece files by relative path.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPVDWriter. Identity: writers/XMLPVDWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers the fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels. {"minimum":0,"type":"integer"} native initialisation / omitted 0
HeaderType Integer width of the size headers that precede binary data blocks in the VTK XML piece files. UInt64 allows arrays larger than 4 GiB; UInt32 gives slightly smaller files that very old VTK readers can open. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "pvd"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPVDWriter"
}

pvWriteXMLPartitionedDataSetCollectionWriter#

Explicit-export writer for VTK XML partitioned dataset collections (.vtpc): an index plus one VTK XML file per partition in a data/ subfolder, keeping the collection's partitioned datasets, names, data assembly and arrays. Scene geometry uses the same format automatically for collections (for example multi-region readers' output); choose this writer for explicit storage settings or block selection. Publication uses the exact contract: ParaView re-reads the .vtpc and the partitions, names, assembly and arrays must match exactly. Use pvWriteXMLMultiBlockDataWriter for multiblock data.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node. ChooseBlocksToWrite true is rejected at planning (BLOCK_SELECTION_UNVERIFIABLE) because no comparison accepts missing blocks; extract the blocks to keep with pvExtractBlock and export that node.
  • Keep the .vtpc and its data/ folder together; the index refers to the pieces by relative path.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPartitionedDataSetCollectionWriter. Identity: writers/XMLPartitionedDataSetCollectionWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPartitionedDataSetCollection"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specifying selectors to choose blocks to extract. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ChooseBlocksToWrite Explicitly choose which blocks to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers in front of each binary or appended data block of the VTK XML files. UInt64 is needed when one array's data exceeds 4 GiB; UInt32 gives marginally smaller files for readers limited to 32-bit headers. It does not affect Ascii output or the stored values. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Selectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue Whether the writer adds the dataset's current time as a TimeValue field-data array in the XML file, so that readers can recover the time from the file alone. Schemaxis records the published time in its receipt instead, and switches this output off whenever the option is omitted. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtpc"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPartitionedDataSetCollectionWriter"
}

pvWriteXMLPolyDataWriter#

Explicit-export writer that saves a polygonal (vtkPolyData) node, such as a slice, contour, extracted surface, lines or points, as a VTK XML PolyData file (.vtp) with its geometry, connectivity and point, cell and field arrays. Schemaxis reopens the file and requires an exact match of structure, connectivity, values and storage types, so the .vtp is a lossless copy of the node. Automatic geometry output already writes .vtp for polydata; choose this writer when you need to control the encoding (DataMode, CompressorType) or want an export receipt. Use pvWriteXMLUnstructuredGridWriter for volume meshes and pvWriteXMLMultiBlockDataWriter for composite data.

Common mistakes and assumptions:

  • The input must be one non-composite polydata; merge or extract a block from multiblock data first, or the input-domain check rejects the export.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Schemaxis switches off the writer's TimeValue field array unless you author it, so the exact comparison sees only the node's own arrays; the selected time is kept in the export receipt.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLPolyDataWriter. Identity: writers/XMLPolyDataWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtp"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLPolyDataWriter"
}

pvWriteXMLRectilinearGridWriter#

Explicit-export writer that saves a rectilinear grid (vtkRectilinearGrid: a structured grid with independent, possibly non-uniform, coordinate arrays along x, y and z) as a VTK XML RectilinearGrid file (.vtr), keeping the extent, the three coordinate arrays and all point, cell and field arrays. Schemaxis verifies the reopened file with an exact comparison. Automatic geometry output already writes .vtr for this type; use this writer to control encoding or to get an explicit export receipt. For uniform spacing the data are usually image data (pvWriteXMLImageDataWriter); for curvilinear grids use pvWriteXMLStructuredGridWriter.

Common mistakes and assumptions:

  • Only a single non-composite rectilinear grid is accepted; other grid types are rejected by the input-domain check rather than converted.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Schemaxis switches off the writer's TimeValue field array unless you author it, so the exact comparison sees only the node's own arrays; the selected time is kept in the export receipt.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLRectilinearGridWriter. Identity: writers/XMLRectilinearGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtr"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLRectilinearGridWriter"
}

pvWriteXMLStructuredGridWriter#

Explicit-export writer that saves a curvilinear structured grid (vtkStructuredGrid: i-j-k topology with explicit point coordinates, typical of body-fitted CFD blocks) as a VTK XML StructuredGrid file (.vts), with extent, points and all point, cell and field arrays. The reopened file must match the node exactly. Automatic geometry already writes .vts for this type; choose this writer for encoding control or an explicit export receipt. Use pvWriteXMLRectilinearGridWriter for axis-aligned grids and pvWriteXMLUnstructuredGridWriter for general meshes.

Common mistakes and assumptions:

  • Multiblock input (for example a multi-zone reader output) is rejected; extract one block first or use pvWriteXMLMultiBlockDataWriter.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Schemaxis switches off the writer's TimeValue field array unless you author it, so the exact comparison sees only the node's own arrays; the selected time is kept in the export receipt.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLStructuredGridWriter. Identity: writers/XMLStructuredGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkStructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vts"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLStructuredGridWriter"
}

pvWriteXMLTableWriter#

Explicit-export writer that saves a table (vtkTable), such as probe-over-line, integration or statistics results, as a VTK XML Table file (.vtt) that keeps every column with its name, type and component count. Unlike pvWriteCSVWriter it is binary-capable and lossless, and Schemaxis verifies the reopened file with an exact comparison. Automatic geometry output already writes .vtt for tables; choose this writer for encoding control or an explicit export receipt. The input must be a single table, not a dataset with point or cell data.

Common mistakes and assumptions:

  • Datasets (meshes) are rejected; convert them to a table upstream if you need tabular output.
  • Choose CSV (pvWriteCSVWriter) instead when the file must be read by spreadsheets or scripts that do not understand VTK XML.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLTableWriter. Identity: writers/XMLTableWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkTable"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtt"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLTableWriter"
}

pvWriteXMLUniformGridAMRWriter#

Explicit-export writer for adaptive-mesh-refinement data (vtkUniformGridAMR, overlapping or non-overlapping): it writes a .vthb index file plus one VTK XML image file per AMR block in a companion folder, keeping levels, refinement ratios, block extents and all arrays. Schemaxis reopens the set (asking the reader for all levels) and requires an exact match. Automatic geometry already writes .vthb for overlapping AMR; choose this writer for encoding or header-size control or an explicit export receipt. pvWriteXMLHierarchicalBoxDataWriter is the deprecated name of the same format.

Common mistakes and assumptions:

  • Keep the .vthb file and its data folder together; the index refers to the block files by relative path.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node. ChooseBlocksToWrite true is rejected at planning (BLOCK_SELECTION_UNVERIFIABLE) because no comparison accepts missing blocks; extract the blocks to keep with pvExtractBlock and export that node.
  • Schemaxis switches off the writer's TimeValue field array unless you author WriteTimeValue, so the exact comparison sees only the node's own arrays; the selected time is kept in the export receipt.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with WriteTimeValue false and the other options at their defaults; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLUniformGridAMRWriter. Identity: writers/XMLUniformGridAMRWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUniformGridAMR"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Assembly Select which assembly is used when specifying selectors to choose blocks to extract. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
ChooseBlocksToWrite Explicitly choose which blocks to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
HeaderType Integer width of the size headers that precede each binary data block in the XML files. UInt64 allows arrays larger than about 4 GiB; UInt32 gives slightly smaller files that some older VTK readers require. Values are unchanged either way. {"type":"enum","values":["UInt32","UInt64"]} native initialisation / omitted "UInt32"
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Selectors Specify the selectors for the data assembly chosen using Assembly to choose the blocks to extract from the input dataset. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
WriteTimeValue When WriteTimeValue is turned ON, the writer write field data time values information, if any. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vthb"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLUniformGridAMRWriter"
}

pvWriteXMLUnstructuredGridWriter#

Explicit-export writer that saves an unstructured grid (vtkUnstructuredGrid: arbitrary cells such as tetrahedra, hexahedra, prisms or polyhedra, the usual output of clip, threshold, merge and many mesh readers) as a VTK XML UnstructuredGrid file (.vtu) with points, cells and all point, cell and field arrays. Schemaxis reopens the file and requires an exact match. Automatic geometry already writes .vtu for this type; choose this writer for encoding control or an explicit export receipt. Use pvWriteXMLPolyDataWriter for surfaces stored as polydata and pvWriteXMLMultiBlockDataWriter for composite data such as an OpenFOAM case.

Common mistakes and assumptions:

  • Composite input (for example foam output with several regions or patches) is rejected; merge the blocks into one unstructured grid with merge first.
  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the exact comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Schemaxis switches off the writer's TimeValue field array unless you author it, so the exact comparison sees only the node's own arrays; the selected time is kept in the export receipt.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XMLUnstructuredGridWriter. Identity: writers/XMLUnstructuredGridWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":false,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkUnstructuredGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
CompressionLevel A compression performance parameter from 1 (faster/larger compressed filesize) to 9 (slower/smaller compressed filesize). {"type":"enum","values":["1","2","3","4","5","6","7","8","9"]} native initialisation / omitted "1"
CompressorType The compression algorithm used to compress binary data (appended mode only). None offers fastest write, LZ4 offers fastest compressed write, ZLib offers balanced performance, LZMA offers smallest compressed filesize. {"type":"enum","values":["None","LZ4","ZLib","LZMA"]} native initialisation / omitted "None"
DataMode The mode uses for writing the file's data i.e. ascii, binary, appended binary. {"type":"enum","values":["Ascii","Binary","Appended"]} native initialisation / omitted "Ascii"
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
EncodeAppendedData When EncodeAppendedData is turned ON, the writer uses base64 encoding when writing binary data (only if appended mode is selected). {"type":"boolean"} native initialisation / omitted false
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "exact",
  "extensions": [
    "vtu"
  ],
  "filenames": "managed output directory",
  "losses": [],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXMLUnstructuredGridWriter"
}

pvWriteXdmf3Writer#

Explicit-export writer for XDMF 3 (.xmf): an XML description of the mesh and arrays with large arrays in an HDF5 companion file, accepting datasets, composite data and graphs. Schemaxis writes one scheduled state and verifies it semantically: the readback must reproduce the mesh geometry and every input point and cell field, while block structure, point identity, connectivity order and storage type may change. Use it for exchange with XDMF 3 tools; pvWriteXdmfWriter writes the older XDMF 2 dialect.

Common mistakes and assumptions:

  • ChooseArraysToWrite true is rejected at planning (ARRAY_SELECTION_UNVERIFIABLE) because the semantic comparison needs every input array in the file; filter arrays with pvPassArrays and export that node.
  • Keep the .xmf file and its HDF5 companion together.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: Xdmf3Writer. Identity: writers/Xdmf3Writer. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkGraph"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellDataArrays Select the cell data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ChooseArraysToWrite Explicitly choose which arrays to write. {"type":"boolean"} native initialisation / omitted false
EdgeDataArrays Select the edge data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FieldDataArrays Select the field data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
GhostLevel The number of ghost levels to include in the output file(s). Note that some writers (such as ExodusIIWriter and CGNSWriter) may not support writing ghost levels. {"minimum":0,"type":"integer"} native initialisation / omitted 0
PointDataArrays Select the point data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
RowDataArrays Select the row data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VertexDataArrays Select the vertex data arrays to pass through. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "xmf"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXdmf3Writer",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvWriteXdmfWriter#

Explicit-export writer for XDMF 2 (.xmf): an XML description of the mesh and arrays, with large arrays stored in an HDF5 file beside it. Schemaxis writes one scheduled state per export and verifies it semantically: the file is read back and the mesh geometry and every input point and cell field must match, while block structure, point identity, connectivity order and storage type may change. Use it to hand results to XDMF-aware tools; pvWriteXdmf3Writer writes the newer XDMF 3 dialect with array selection.

Common mistakes and assumptions:

  • Keep the .xmf file and its HDF5 companion together; the XML refers to the heavy data by file name.
  • An earlier catalogue run (verification/2026-09-16-catalogue-expansion.json, writerQualification) passed only on a small serial fixture with default options; no current native acceptance check is recorded, so verify the export on representative data.

Native constructor: XdmfWriter. Identity: writers/XdmfWriter. Role: writer. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Connect upstream object to Input True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
MeshStaticOverTime With true, ParaView writes the topology and geometry of the first time step once and lets later steps reference them. Schemaxis writes one time state per export, so that sharing never happens, but the setting still changes a single step: ParaView forces all heavy data into the HDF5 file (light-data limit 1) and stores topology and geometry as /Topology_<grid> and /Geometry_<grid> HDF5 datasets. {"type":"boolean"} native initialisation / omitted false

Output publication contract:

{
  "comparison": "semantic",
  "extensions": [
    "xmf"
  ],
  "filenames": "managed output directory",
  "losses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ],
  "qualification": "requires fixture",
  "time": "one scheduled state"
}

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "explicit exports with semantic readback",
  "outputPorts": 0,
  "qualification": "not-run"
}

Syntax example#

Place in scenes[].exports; writers cannot be graph nodes. The main data input is node; non-data ports go in resources.

{
  "id": "exportResult",
  "node": "DATA_NODE",
  "writer": "pvWriteXdmfWriter",
  "acceptLosses": [
    "structure",
    "point-identity",
    "connectivity-order",
    "storage-type"
  ]
}

pvXDMFReader#

Reads XDMF 2 files (.xmf/.xdmf): XML metadata with heavy arrays in HDF5. The output is the file's grid type (unstructured, structured or rectilinear) or a multiblock when it has several grids. Several file names form a file series read as time steps. Selections choose which grids, sets and point or cell arrays are loaded, and Stride subsamples structured grids. It is a distributed reader. pvXdmf3ReaderT and pvXdmf3ReaderS read XDMF 3 files.

Common mistakes and assumptions:

  • The HDF5 file must stay where the XML references it, usually beside the .xmf file.
  • Array, grid and set selections start from ParaView's choice; list them when later steps depend on particular names.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: XDMFReader. Identity: sources/XdmfReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to load from the XDMF file. Arrays not listed are not read; the available names come from the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileNames The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
GridStatus Names of the grids to read when the file holds several grids (for example one per part or domain) in a collection. Unlisted grids are skipped; selecting a single grid can give a plain dataset instead of a multiblock. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to load from the XDMF file. Arrays not listed are not read, which saves memory and time; the available names come from the file. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
SetStatus Names of the XDMF sets (named groups of nodes, cells, faces or edges defined in the file, e.g. boundary patches) to load. Sets marked as ghost sets in the file cannot be selected. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Stride If loading structured data, this property indicate the number of indices per dimension (X, Y, or Z) to skip between each point included in this output. {"items":{"type":"integer"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXDMFReader",
  "options": {
    "FileNames": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLHierarchicalBoxDatareader#

Reads VTK XML hierarchical-box AMR files (.vthb, .vth) in the version 1.0 or older layout: a summary file referring to vtkUniformGrid pieces at several refinement levels, read as an overlapping AMR dataset. For the newer layout use pvXMLUniformGridAMRReader, which also offers array selection and a level limit. Several summary files form a time series.

Common mistakes and assumptions:

  • Upstream help for FileName says these files are VTK XML polydata (.vtp); that is a copy error, the reader expects .vthb or .vth AMR summary files.
  • Keep the summary file with the piece files it refers to when moving the data.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLHierarchicalBoxDatareader. Identity: sources/XMLHierarchicalBoxDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Hierarchical-box AMR summary files (.vthb or .vth, version 1.0 or older layout) to read. One file gives one dataset; several files are read as a file series, one time step per file in the order listed. Each file refers to its uniform-grid piece files, which must stay with it. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLHierarchicalBoxDatareader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLImageDataReader#

Reads VTK XML image data files (.vti) into image data (vtkImageData): a uniform grid defined by origin, spacing and extent, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readImageData for the simple single-file case and pvXMLPartitionedImageDataReader for .pvti pieces.

Common mistakes and assumptions:

  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLImageDataReader. Identity: sources/XMLImageDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the image cells (voxels) in the VTK XML image data file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML image data format. The standard extension is .vti. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the image points in the VTK XML image data file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLImageDataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLMultiBlockDataReader#

Reads VTK XML multiblock files (.vtm, .vtmb) into a multiblock dataset whose named blocks are read from the serial VTK XML files the .vtm meta file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readMultiBlock for the simple single-file case; PieceDistribution only matters in parallel.

Common mistakes and assumptions:

  • The .vtm file is a meta file; the block files it lists (usually in a folder of the same name) must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLMultiBlockDataReader. Identity: sources/XMLMultiBlockDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the block cells in the VTK XML multiblock file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName VTK XML multiblock meta files (.vtm or .vtmb) to read. One file gives one multiblock dataset; several files are read as a file series, one time step per file in the order listed. Each .vtm refers to serial VTK XML block files, which must stay with it. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PieceDistribution Control how datasets are loaded in parallel. {"type":"enum","values":["Block","Interleave"]} native initialisation / omitted "Block"
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the block points in the VTK XML multiblock file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLMultiBlockDataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedDatasetCollectionReader#

Reads VTK XML partitioned dataset collection files (.vtpc) into a partitioned dataset collection: several datasets, each split into partitions, with an optional assembly hierarchy, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLMultiBlockDataReader for .vtm files and pvXMLPartitionedDatasetReader for one partitioned dataset (.vtpd).

Common mistakes and assumptions:

  • The .vtpc file is a meta file; the serial VTK XML files it lists must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedDatasetCollectionReader. Identity: sources/XMLPartitionedDataSetCollectionReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the partition cells in the VTK XML partitioned dataset collection file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PieceDistribution Control how datasets are loaded in parallel. {"type":"enum","values":["Block","Interleave"]} native initialisation / omitted "Block"
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the partition points in the VTK XML partitioned dataset collection file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedDatasetCollectionReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedDatasetReader#

Reads VTK XML partitioned dataset files (.vtpd) into a partitioned dataset: one dataset split into partitions read from the serial VTK XML files the .vtpd meta file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLPartitionedDatasetCollectionReader for .vtpc collections of several datasets.

Common mistakes and assumptions:

  • The .vtpd file is a meta file; the partition files it lists must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedDatasetReader. Identity: sources/XMLPartitionedDataSetReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the partition cells in the VTK XML partitioned dataset file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PieceDistribution Control how datasets are loaded in parallel. {"type":"enum","values":["Block","Interleave"]} native initialisation / omitted "Block"
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the partition points in the VTK XML partitioned dataset file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedDatasetReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedHyperTreeGridReader#

Reads partitioned VTK XML hypertree grid data: a .phtg summary file and the .htg piece files it lists, assembled into a hypertree grid (adaptive tree-based AMR mesh). Several summary files form a time series. Use pvHyperTreeGridReader for a single .htg file, which also offers a level limit and a selection box.

Common mistakes and assumptions:

  • The .phtg summary refers to .htg piece files, which must stay with it.
  • Many general filters do not accept hypertree grids; convert with pvHyperTreeGridToUnstructuredGrid when needed.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedHyperTreeGridReader. Identity: sources/XMLPHyperTreeGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML phtg data format. The standard extension is .phtg. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedHyperTreeGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedImageDataReader#

Reads partitioned VTK XML image data files (.pvti) into image data (vtkImageData) assembled from the .vti pieces the .pvti summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLImageDataReader or readImageData for a single .vti file.

Common mistakes and assumptions:

  • The .pvti summary refers to .vti piece files, which must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedImageDataReader. Identity: sources/XMLPImageDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the image cells (voxels) in the partitioned VTK XML image data file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML image data format. The standard extension is .pvti. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the image points in the partitioned VTK XML image data file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedImageDataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedPolydataReader#

Reads partitioned VTK XML polydata files (.pvtp) into polydata assembled from the .vtp pieces the .pvtp summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readParallelPolyData for the simple single-file case and pvXMLPolyDataReader for one .vtp file.

Common mistakes and assumptions:

  • The .pvtp summary refers to .vtp piece files, which must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedPolydataReader. Identity: sources/XMLPPolyDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the polygons, lines and vertices in the partitioned VTK XML polydata file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML polygonal dataset format. The standard extension is .pvtp. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the surface points in the partitioned VTK XML polydata file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedPolydataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedRectilinearGridReader#

Reads partitioned VTK XML rectilinear grid files (.pvtr) into a rectilinear grid (axis-aligned, with per-axis coordinate arrays) assembled from the .vtr pieces the .pvtr summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLRectilinearGridReader or readRectilinearGrid for a single .vtr file.

Common mistakes and assumptions:

  • The .pvtr summary refers to .vtr piece files, which must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedRectilinearGridReader. Identity: sources/XMLPRectilinearGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the grid cells in the partitioned VTK XML rectilinear grid file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML rectilinear grid data format. The standard extension is .pvtr. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the grid points in the partitioned VTK XML rectilinear grid file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedRectilinearGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedStructuredGridReader#

Reads partitioned VTK XML structured grid files (.pvts) into a structured (curvilinear) grid assembled from the .vts pieces the .pvts summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use pvXMLStructuredGridReader or readStructuredGrid for a single .vts file.

Common mistakes and assumptions:

  • The .pvts summary refers to .vts piece files, which must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedStructuredGridReader. Identity: sources/XMLPStructuredGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the grid cells in the partitioned VTK XML structured grid file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML structured grid data format. The standard extension is .pvts. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the grid points in the partitioned VTK XML structured grid file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedStructuredGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedTableReader#

Reads partitioned VTK XML table data: a .pvtt summary file and the .vtt piece files it lists, assembled into one table (vtkTable) of named columns with no geometry. Several summary files form a time series. Use pvXMLTableReader for one .vtt file and pvCSVReader for text tables.

Common mistakes and assumptions:

  • The .pvtt summary refers to .vtt piece files, which must stay with it.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedTableReader. Identity: sources/XMLPTableReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColumnArrayStatus Names of the table columns to read. Columns not listed are skipped, which saves memory for wide tables; row count is unaffected. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML table data format. The standard extension is .pvtt. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedTableReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPartitionedUnstructuredGridReader#

Reads partitioned VTK XML unstructured grid files (.pvtu) into an unstructured grid assembled from the .vtu pieces the .pvtu summary file lists, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readParallelUnstructuredGrid for the simple single-file case and pvXMLUnstructuredGridReader for one .vtu file.

Common mistakes and assumptions:

  • The .pvtu summary refers to .vtu piece files, which must stay with it.
  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPartitionedUnstructuredGridReader. Identity: sources/XMLPUnstructuredGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the mesh cells in the partitioned VTK XML unstructured grid file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML unstructured grid data format. The standard extension is .pvtu. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the mesh points in the partitioned VTK XML unstructured grid file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPartitionedUnstructuredGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLPolyDataReader#

Reads VTK XML polydata files (.vtp) into polydata: surfaces, lines and vertices, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readSurface for the simple single-file case and pvXMLPartitionedPolydataReader for .pvtp pieces.

Common mistakes and assumptions:

  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLPolyDataReader. Identity: sources/XMLPolyDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the polygons, lines and vertices in the VTK XML polydata file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the surface points in the VTK XML polydata file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLPolyDataReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLRectilinearGridReader#

Reads VTK XML rectilinear grid files (.vtr) into a rectilinear grid (axis-aligned, with per-axis coordinate arrays), with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readRectilinearGrid for the simple single-file case and pvXMLPartitionedRectilinearGridReader for .pvtr pieces.

Common mistakes and assumptions:

  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLRectilinearGridReader. Identity: sources/XMLRectilinearGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the grid cells in the VTK XML rectilinear grid file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML rectilinear grid data format. The standard extension is .vtr. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the grid points in the VTK XML rectilinear grid file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLRectilinearGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLStructuredGridReader#

Reads VTK XML structured grid files (.vts) into a structured (curvilinear) grid with explicit point coordinates, with the selected point and cell arrays and any field data. The VTK XML formats keep every array as written, so this is the natural way to reload data saved by ParaView, VTK or Schemaxis exports. Several file names form a time series. Use readStructuredGrid for the simple single-file case and pvXMLPartitionedStructuredGridReader for .pvts pieces.

Common mistakes and assumptions:

  • Arrays left out of CellArrayStatus or PointArrayStatus are not read; name the arrays later nodes need.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so check the output on your own files.

Native constructor: XMLStructuredGridReader. Identity: sources/XMLStructuredGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to read, i.e. values stored on the grid cells in the VTK XML structured grid file's CellData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without cell arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML structured grid data format. The standard extension is .vts. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to read, i.e. values stored at the grid points in the VTK XML structured grid file's PointData. Arrays not listed are skipped, saving memory and read time; an empty list reads the geometry without point arrays. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLStructuredGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLTableReader#

Reads a VTK XML table file (.vtt): a vtkTable of named columns with no geometry, such as values exported by an extract-attributes or statistics step. The output is a table, so use it for plotting, statistics or CSV-style export rather than for rendering or spatial filters. Several files (or a .vtt.series file) form a time series with one file per time step. For geometry use readSurface, readUnstructuredGrid or the other VTK XML readers.

Common mistakes and assumptions:

  • A table has no points or cells; spatial operations such as slice or clip reject it.
  • TimeArray (ParaView default "TimeValue") takes each file's time from a field-data array of that name when present; otherwise steps are numbered from 0.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: XMLTableReader. Identity: sources/XMLTableReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
ColumnArrayStatus Names of the table columns to load from the file. Arrays not listed are not read and are absent from the output, which saves memory and read time on large files; listed names that the file does not contain are ignored by the native reader. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML table format. The standard extension is .vtt. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLTableReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLUniformGridAMRReader#

Reads a VTK XML overlapping or non-overlapping AMR file (.vthb, or the older .vth): a hierarchy of refinement levels made of uniform-grid blocks, as written by AMR codes or by ParaView. The output is a vtkOverlappingAMR or vtkNonOverlappingAMR composite dataset. ParaView reads only DefaultNumberOfLevels levels unless a downstream filter asks for more, and its default is 1, so by default only the coarsest level is loaded. Use pvAMRGaussianPulseSource for a synthetic AMR test dataset.

Common mistakes and assumptions:

  • Set DefaultNumberOfLevels to 0 (no limit) or to the number of levels you need; the ParaView default of 1 silently drops all refined levels.
  • On overlapping AMR, coarse cells under refined patches are blanked rather than removed; operations that ignore blanking count those regions twice.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: XMLUniformGridAMRReader. Identity: sources/XMLUniformGridAMRReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to load from the file. Arrays not listed are not read and are absent from the output, which saves memory and read time on large files; listed names that the file does not contain are ignored by the native reader. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
DefaultNumberOfLevels This reader supports demand-driven heavy data reading i.e. downstream pipeline can request specific blocks from the AMR using vtkCompositeDataPipeline::UPDATE_COMPOSITE_INDICES() key in RequestUpdateExtent() pass. However, when down-stream doesn't provide any specific keys, the default behavior can be setup to read at-most N levels by default. The number of levels read can be set using this method. Set this to 0 to imply no limit. Default is 1. {"type":"integer"} native initialisation / omitted 1
FileName The AMR file or files to read: a VTK XML hierarchical-box file (.vthb or the older .vth) or a matching .series index. Several files are read as a file series, one file per time step. The native documentation's mention of .vtp polygonal files is a copy error in the ParaView XML; this reader accepts AMR files only. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to load from the file. Arrays not listed are not read and are absent from the output, which saves memory and read time on large files; listed names that the file does not contain are ignored by the native reader. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLUniformGridAMRReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXMLUnstructuredGridReader#

Generated binding of ParaView's XML Unstructured Grid Reader: reads VTK XML unstructured grid files (.vtu) holding arbitrary cells (tetrahedra, hexahedra, polyhedra, mixed) with point and cell arrays, and outputs a vtkUnstructuredGrid. Unlike the curated readUnstructuredGrid (one file, every array), it accepts a list of files read as a time series and lets you choose which point and cell arrays to load. Use readParallelUnstructuredGrid for partitioned .pvtu output.

Common mistakes and assumptions:

  • Use readUnstructuredGrid for the simple single-file case; it is the reader covered by Schemaxis's reader fixture.
  • With several files, time comes from each file's "TimeValue" field data when present (TimeArray), otherwise the step index; check the times before animating.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: XMLUnstructuredGridReader. Identity: sources/XMLUnstructuredGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellArrayStatus Names of the cell-centred arrays to load from the file. Arrays not listed are not read and are absent from the output, which saves memory and read time on large files; listed names that the file does not contain are ignored by the native reader. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Each file is expected to be in the VTK XML unstructured grid data format. The standard extension is .vtu. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrayStatus Names of the point-centred arrays to load from the file. Arrays not listed are not read and are absent from the output, which saves memory and read time on large files; listed names that the file does not contain are ignored by the native reader. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
TimeArray Names the field-data array that holds the time value of each time step (ParaView's XML default is TimeValue). Choose the entry "None" to number the steps with the integers 0, 1, 2, ... instead of reading a time array. ParaView's own description calls that entry "Default", but the list's no-selection entry is "None". {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXMLUnstructuredGridReader",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXYZReader#

Reads an XYZ molecular file (.xyz: atom count, comment line, then element symbol and x y z per atom) into a vtkMolecule; files with several consecutive frames become time steps. Bonds are not stored in the format; use pvComputeMoleculeBonds to derive them and pvMoleculeToLines to obtain polydata for general filters. Use pvPDBReader or pvCMLMoleculeReader for formats that carry more chemistry.

Common mistakes and assumptions:

  • Coordinates are used as written (normally ångströms); nothing is converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: XYZReader. Identity: sources/xyzreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName This property specifies the file name for the XYZ reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXYZReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvXdmf3ReaderS#

Reads XDMF 3 files (.xmf/.xdmf) with heavy data in HDF5. A single domain with one grid gives that dataset type; otherwise the output is a multiblock. This variant treats a series of files as spatial partitions of one dataset (top-level partitioning) (AsTime false by default). Point and cell arrays and named sets can be selected. Use pvXdmf3ReaderT for the other file-series interpretation and pvXDMFReader for XDMF 2 files.

Common mistakes and assumptions:

  • The HDF5 files must stay where the XML references them.
  • Array and set selections start from ParaView's choice; list them when later steps depend on particular names.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: Xdmf3ReaderS. Identity: sources/Xdmf3ReaderS. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AsTime This hidden property controls whether the reader should treat a file series as a temporal or spatial partitioning. {"type":"boolean"} native initialisation / omitted false
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Sets Select the sets to be loaded from the dataset, if any. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXdmf3ReaderS",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvXdmf3ReaderT#

Reads XDMF 3 files (.xmf/.xdmf) with heavy data in HDF5. A single domain with one grid gives that dataset type; otherwise the output is a multiblock. This variant treats a series of files as successive time steps (AsTime true by default). Point and cell arrays and named sets can be selected. Use pvXdmf3ReaderS for the other file-series interpretation and pvXDMFReader for XDMF 2 files.

Common mistakes and assumptions:

  • The HDF5 files must stay where the XML references them.
  • Array and set selections start from ParaView's choice; list them when later steps depend on particular names.
  • Schemaxis generates this reader binding from ParaView's catalogue; it has not run a native acceptance check with a sample file of this format.

Native constructor: Xdmf3ReaderT. Identity: sources/Xdmf3ReaderT. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AsTime This hidden property controls whether the reader should treat a file series as a temporal or spatial partitioning. {"type":"boolean"} native initialisation / omitted false
CellArrays This property lists which cell-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"items":{"minLength":1,"type":"string"},"minItems":1,"type":"array"} required ["REPLACE_WITH_VALUE"]
PointArrays This property lists which point-centered arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Sets Select the sets to be loaded from the dataset, if any. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvXdmf3ReaderT",
  "options": {
    "FileName": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

pvYieldCriteria#

Evaluates yield criteria of selected symmetric stress tensors from their principal values σ1 ≥ σ2 ≥ σ3: Tresca as |σ3 − σ1| and von Mises as √(((σ1 − σ2)² + (σ2 − σ3)² + (σ1 − σ3)²) / 2), stored as <name> - Tresca Criterion and <name> - Von Mises Criterion in the tensor's units. The Principal Stress choice also keeps the principal value and direction arrays. Use it in structural post-processing to compare stress states with a material's yield strength. Tensor requirements match pvTensorPrincipalInvariants (6 components XX, YY, ZZ, XY, YZ, XZ, or 3 named XX, YY, XY).

Common mistakes and assumptions:

  • The Tresca value here is the full principal-stress difference, twice the maximum shear stress; compare it with the yield strength, not the shear yield strength.
  • If no criterion is selected the input passes through unchanged.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: YieldCriteria. Identity: filters/YieldCriteria. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CellTensors Cell tensors from which to compute principal invariants. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
PointTensors Point tensors from which to compute principal invariants. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ScalePrincipalVectorsWithPrincipalValues Principal vectors can be scaled by the principal values instead of being unitary. {"type":"boolean"} native initialisation / omitted false
YieldCriteria Quantities to compute. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvYieldCriteria",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pvYoungsMaterialInterface#

Reconstructs sharp material interfaces in mixed cells of Eulerian or ALE multi-material simulations (e.g. CTH or other volume-of-fluid output) with Youngs' method: in each cell the material is bounded by a plane perpendicular to its interface normal, placed so the cut volume matches the cell's volume fraction. Input is a composite dataset with one cell-centred volume fraction array per material and, ideally, a 3-component cell normal array per material. Output is a multiblock with one block per material (in VolumeFractionArrays order) holding the interface polygons or, with FillMaterial (ParaView default), the material's volume.

Common mistakes and assumptions:

  • Without a normal array for a material, VTK uses the +x direction, so interfaces come out as planes perpendicular to x; supply normals (e.g. from the volume-fraction gradient).
  • AxisSymetric is true by ParaView default and treats 2-D meshes as axisymmetric (volumes of revolution); set it false for planar 2-D data.
  • Only 2-D and 3-D cells are processed and input must be composite (e.g. multiblock); wrap a single mesh with pvGroupDatasets first.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: YoungsMaterialInterface. Identity: filters/YoungsMaterialInterface. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
Input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: composite data (multiblock or partitioned collections) (vtkCompositeDataSet). The input needs at least one cell-centred array with 1 component. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AxisSymetric For 2-D cells, treats the mesh as an axisymmetric section (volume of revolution about the axis) when placing interfaces, so cut positions honour revolved volumes rather than planar areas. It has no effect on 3-D cells. Native name keeps ParaView's spelling. {"type":"boolean"} native initialisation / omitted false
FillMaterial When true, each material block contains the material's volume: pure cells whole plus the material side of every cut mixed cell. When false, only the interface itself is output (polygons in 3-D, lines in 2-D) and pure cells are omitted. {"type":"boolean"} native initialisation / omitted false
InverseNormal Flips the sign of every material normal before the interface is placed, which moves the material to the other side of its interface plane. Use it when the supplied normals point out of the material (e.g. a plain volume-fraction gradient points into it). {"type":"boolean"} native initialisation / omitted false
NormalArrays Assigns an interface-normal cell array to materials, as a flat list of pairs [volume-fraction array, normal array, volume-fraction array, normal array, …]. Each normal array is a 3-component cell array giving the interface orientation for that material; materials without one get a degenerate normal replaced by +x. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
OnionPeel When true, materials are processed in order within each cell and all use the first material's normal, like layers of an onion, which keeps nested interfaces parallel and avoids overlaps in cells with three or more materials. When false, each material uses its own normal. {"type":"boolean"} native initialisation / omitted false
OrderingArrays Assigns an ordering cell array to materials, as a flat list of pairs [volume-fraction array, ordering array, …]. In each cell, materials are processed in ascending order of their ordering value (descending with ReverseMaterialOrder), which matters with OnionPeel. Materials without one have ordering 0 and keep their VolumeFractionArrays order. Complete tuples of 2 values. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ReverseMaterialOrder Reverses the order in which materials are processed in each cell (descending ordering value instead of ascending, or reverse list order without ordering arrays). With OnionPeel this changes which material forms the inner layer. {"type":"boolean"} native initialisation / omitted false
UseFractionAsDistance When true, the volume-fraction value is used directly as the distance of the interface plane from the cell origin along the normal, instead of solving for the plane that matches the volume fraction; the fraction range thresholds are then bypassed. Use it only when the arrays store plane distances (e.g. level-set style data). {"type":"boolean"} native initialisation / omitted false
VolumeFractionArrays Names of the cell-centred volume-fraction arrays (values 0 to 1), one per material; the list order is the material index and the order of the output blocks. Blocks lacking an array simply contribute nothing for that material. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
VolumeFractionRange Thresholds [min, max] on a material's volume fraction in a cell: at or below min the cell is treated as empty of that material, at or above max as full (copied whole only when FillMaterial is true), and in between an interface is reconstructed. Narrowing the range removes slivers from nearly pure cells. {"items":{"maximum":1.0,"minimum":0.0,"type":"number"},"maxItems":2,"minItems":2,"type":"array"} native initialisation / omitted [0.0,0.0]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvYoungsMaterialInterface",
  "inputs": {
    "Input": "UPSTREAM_Input"
  }
}

pva2DGlyph#

Creates one flat 2-D marker in the x-y plane as polydata: vertex, dash, cross, thick cross, triangle, square, circle, diamond or one of four arrow styles (GlyphType, ParaView default Arrow), about one unit in size around Center. Use it as the glyph shape for 2-D vector or point-marker plots, or as an annotation symbol.

Common mistakes and assumptions:

  • Filled only affects closed shapes (triangle, square, circle, diamond, thick variants); open shapes stay as lines.
  • DoublePointed, PointInwards and TipLength only apply to the arrow glyph types.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: a2DGlyph. Identity: sources/GlyphSource2D. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Center Set the x, y, z coordinates of the origin of the 2D glyph. {"items":{"type":"number"},"maxItems":3,"minItems":3,"type":"array"} native initialisation / omitted [1,1,1]
DoublePointed Display double pointed arrow. {"type":"boolean"} native initialisation / omitted false
Filled If the value of this property is 1, the 2D glyph will be a filled polygon; otherwise, only the edges (line segments) will be included in the output. This only applies to closed 2D glyphs. {"type":"boolean"} native initialisation / omitted false
GlyphType This property specifies the type of the 2D glyph. {"type":"enum","values":["Vertex","Dash","Cross","ThickCross","Triangle","Square","Circle","Diamond","Arrow","ThickArrow","HookedArrow","EdgeArrow"]} native initialisation / omitted "Vertex"
PointInwards Make the arrow tip point inwards. {"type":"boolean"} native initialisation / omitted false
TipLength Length of the arrow tip. {"maximum":1.0,"minimum":0.0,"type":"number"} native initialisation / omitted 0.0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pva2DGlyph"
}

pva3DText#

Creates polygonal (filled outline) geometry spelling Text in a vector font, lying in the x-y plane with the text starting near the origin and characters about one unit tall. It is real geometry, so it can be transformed, clipped or exported, unlike a screen-space text annotation. Use it to label parts of a 3-D scene.

Common mistakes and assumptions:

  • Only printable ASCII characters and "\n" line breaks are supported.
  • Scale and place the text with a transform; the source has no size or position options.
  • Schemaxis generates this source from ParaView's catalogue; it has not run a native acceptance check for it, so inspect the output before relying on it.

Native constructor: a3DText. Identity: sources/VectorText. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Text This property contains the text string to be displayed. The ASCII alphanumeric characters a-z, A-Z, and 0-9 are supported; so are ASCII punctuation marks. The only supported control character is "\n", which inserts a new line in the text string. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pva3DText"
}

pvglTFReader#

Reads a glTF 2.0 asset (.gltf with external buffers, or binary .glb) into a multiblock dataset of polydata for one scene, with skinning, morph targets and enabled animations applied to the geometry when ApplyDeformationsToGeometry is true. Animations become time steps sampled at Framerate. Materials and textures are not applied. Use it to bring 3-D models or animated scenes into a pipeline; for static CAD surfaces pvWavefrontOBJReader or readSTL are simpler.

Common mistakes and assumptions:

  • No animation is enabled by default (glTF does not define which should play); list them in AnimationStatus to get time steps.
  • glTF coordinates are metres by specification, but scenes from other tools may not follow that; nothing is converted.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: glTFReader. Identity: sources/glTF 2.0 Reader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
AnimationStatus Select the animations to enable. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
ApplyDeformationsToGeometry When true, skinning, morph-target and animation transforms are applied to the output point coordinates, so the geometry is posed for the current frame; false leaves the geometry undeformed and stores the transforms in field data. ParaView shows AnimationStatus and Framerate only when this is true. {"type":"boolean"} native initialisation / omitted false
FileName Path of the .gltf or .glb file (glTF 2.0 only). A .gltf file refers to its .bin buffers and images by relative URI, so they must stay beside it; .glb embeds them. Relative paths are resolved from the working directory of the Schemaxis process (in Studio, the directory it was launched from), not from the JSON file's folder; the value is passed when the node is created and must be a constant. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
Framerate Sampling rate used to turn enabled animations into discrete time steps: steps run from 0 to the longest enabled animation's duration every 1/Framerate seconds, plus the final instant. 0 publishes only a time range without steps. It matters only when an animation is enabled. {"type":"integer"} native initialisation / omitted 1
Scene Name of the glTF scene to read when the file defines several. Names are the file's scene names made unique (unnamed scenes become Unnamed, duplicates get _1, _2 suffixes); an unknown name makes vtkGLTFReader warn and keep its current scene. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvglTFReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvopenPMDReader#

Reads an openPMD particle-mesh data series (plasma and accelerator simulations such as WarpX or PIConGPU) through a .pmd file: a text file whose first line is the openPMD file pattern, e.g. "data_%T.h5", resolved next to the .pmd file. Output port 0 is the mesh records as image data (a vtkPartitionedDataSet), port 1 the particle species as point clouds (a vtkPartitionedDataSetCollection, one per species); select it with {"node": id, "port": 1}. Values, coordinates and times are converted to SI using the openPMD unit factors.

Common mistakes and assumptions:

  • The reader needs the openpmd_api Python module inside ParaView's Python; without it nothing is read.
  • Point FileName at the .pmd pattern file, not at an individual HDF5 or ADIOS iteration file.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: openPMDReader. Identity: sources/OpenPMDReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
Arrays Select the arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
FileName Specify the file name. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ParticleArrays Select the particle-arrays to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]
Species Select the species to read. {"items":{"type":"string"},"type":"array"} native initialisation / omitted ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": 2,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvopenPMDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvproSTARSTARCDReader#

Reads a proSTAR (STAR-CD) mesh stored as ASCII .vrt (vertices) and .cel (cells) files with a common base name into an unstructured grid; pass either file. ScaleFactor multiplies all coordinates, e.g. 0.001 to convert a millimetre mesh to metres. Only geometry is read, not solution fields.

Common mistakes and assumptions:

  • Both .vrt and .cel files must be present with the same base name.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this reader, so inspect the output blocks, arrays and time steps on your own files before relying on it.

Native constructor: proSTARSTARCDReader. Identity: sources/ProStarReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
FileName Set the file name for the proSTAR (STARCD) reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"
ScaleFactor Scaling factor for the points {"type":"number"} native initialisation / omitted 1

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvproSTARSTARCDReader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

pvspcthhistoryreader#

Reads a CTH Spy Plot history file (.hscth, names matching hsct): delimited text in which each row is one time step and the columns hold tracer-point positions, materials and properties. The output is a table (vtkTable), with the rows exposed as time steps, suitable for plotting probe histories; it is not a mesh. Use pvSpyPlotReader for the field data itself.

Common mistakes and assumptions:

  • If the file uses a separator other than a comma, set Delimeter (native spelling) or the columns run together.
  • Schemaxis generates this binding from ParaView's catalogue; it has not run a native acceptance check for this operation.

Native constructor: spcthhistoryreader. Identity: sources/spcthhistoryreader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
CommentCharacter This property lists the characters that is used as the first character on comment lines {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
Delimeter Character that is used as the delimiter. {"type":"string"} native initialisation / omitted "REPLACE_WITH_VALUE"
FileName This property specifies the file name for the VRML reader. Fixed at construction; cannot vary per visit. {"minLength":1,"type":"string"} required "REPLACE_WITH_VALUE"

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Coverage and unbound native properties:

{
  "defaults": "native defaults for omitted options",
  "gaps": {},
  "origin": "generated",
  "output": "native inspection required; explicit output-port selection available",
  "outputPorts": null,
  "qualification": "not-run"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "pvspcthhistoryreader",
  "options": {
    "FileName": "REPLACE_WITH_VALUE"
  }
}

readImageData#

Reads one VTK XML image data file (.vti) into vtkImageData: a uniform grid defined by extent, origin and spacing, with point and cell arrays. Use it for voxel or pixel data such as sampled volumes, resampled CFD fields or images exported by ParaView; the result suits volume rendering, contouring and image filters. For curvilinear or irregular meshes use readStructuredGrid or readUnstructuredGrid.

Common mistakes and assumptions:

  • Every point and cell array is read; on large volumes use the generated pvXMLImageDataReader binding, which can select arrays.
  • Only one file is read; for a time series use a .pvd collection (pvPVDReader) or the generated pvXMLImageDataReader binding.

Native constructor: XMLImageDataReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the VTK XML image data format. The standard extension is .vti. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readImageData",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readMultiBlock#

Reads a VTK XML multiblock file (.vtm, or the older .vtmb): a small index file that names the serial VTK XML files of each block and nests them in a block hierarchy. The output is a vtkMultiBlockDataSet whose leaves may mix datasets of different types. Use it to reopen composite results such as a multi-region case saved by ParaView or Schemaxis; follow it with extractBlock to pick blocks or merge to combine them into one dataset.

Common mistakes and assumptions:

  • Keep the .vtm file together with its block-file folder; the index refers to the block files by relative path.
  • Many filters run per block; merge the blocks first when an operation must see one connected dataset.

Native constructor: XMLMultiBlockDataReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The single VTK XML multiblock index file to read (.vtm, or the older .vtmb). The block files it refers to are read automatically. Exactly one path is accepted. The native documentation's mention of .vtp polygonal files and file series is a copy error in the ParaView XML and does not apply here. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readMultiBlock",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readPLY#

Curated PLY reader: reads exactly one Stanford PLY file (ASCII or binary) into polydata, with vertex properties such as normals, colours or texture coordinates carried as arrays. PLY has no unit, so coordinates are in whatever unit the scanner or CAD tool used. Use it for scanned or meshed surfaces to render, clip or probe; use pvPLYReader for file series or texture settings, and readSTL for STL.

Common mistakes and assumptions:

  • Check the coordinate unit (millimetres versus metres) against the simulation data before combining them; nothing is converted.

Native constructor: PLYReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readPLY",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readParallelPolyData#

Reads a partitioned VTK XML polydata dataset: the .pvtp summary file plus the per-piece .vtp files it lists, typically written by an MPI run. The pieces are combined into polydata (surfaces, lines, vertices) with their point and cell arrays. Use it to reopen distributed surface output, including Schemaxis's own native parallel geometry; in Schemaxis MPI runs it is one of the operations qualified for distributed reading. Use readSurface for a single .vtp file.

Common mistakes and assumptions:

  • The .pvtp summary refers to its piece files by relative path; move them together.
  • Pieces may share boundary points; run clean before connectivity or point-count checks.

Native constructor: XMLPartitionedPolydataReader. Identity: sources/XMLPPolyDataReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML polygonal dataset format. The standard extension is .pvtp. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readParallelPolyData",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readParallelUnstructuredGrid#

Reads a partitioned VTK XML unstructured grid: the .pvtu summary file plus the per-piece .vtu files it lists, typically written by an MPI run. The result is an unstructured grid with the point and cell arrays of all pieces. Use it to reopen distributed volume output, including Schemaxis's native parallel geometry (examples/schemaxis/foam-native-parallel.json); it is in Schemaxis's MPI-qualified operation list. Use readUnstructuredGrid for a single .vtu file.

Common mistakes and assumptions:

  • The .pvtu summary refers to its piece files by relative path; move them together.
  • Ghost cells or duplicated interface points between pieces can affect counts and integrals; check vtkGhostType or clean the grid when exact counts matter.

Native constructor: XMLPartitionedUnstructuredGridReader. Identity: sources/XMLPUnstructuredGridReader. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML unstructured grid data format. The standard extension is .pvtu. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readParallelUnstructuredGrid",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readRectilinearGrid#

Reads one VTK XML rectilinear grid file (.vtr) into vtkRectilinearGrid: an axis-aligned structured grid whose x, y and z coordinates are given by three independent (possibly non-uniform) coordinate arrays. Use it for tensor-product meshes with graded spacing, e.g. stretched finite-difference grids. For uniform spacing readImageData is the lighter equivalent; for curved structured meshes use readStructuredGrid.

Common mistakes and assumptions:

  • Some image filters require vtkImageData; resample to an image when a downstream operation rejects rectilinear input.

Native constructor: XMLRectilinearGridReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the VTK XML rectilinear grid data format. The standard extension is .vtr. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readRectilinearGrid",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readSTL#

Reads one ASCII or binary STL file into polydata made of triangles. STL stores only triangle geometry, with no units or field arrays, so coordinates are in whatever unit the exporting CAD tool used. Use it for CAD or scanned surfaces to render, clip against, or probe onto; add normals for smooth shading. Schemaxis reads exactly one file (no file series).

Common mistakes and assumptions:

  • Check the coordinate unit (millimetres versus metres) against the simulation data before combining them; nothing is converted.

Native constructor: STLReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readSTL",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readStructuredGrid#

Reads one VTK XML structured grid file (.vts) into vtkStructuredGrid: a curvilinear i-j-k grid with explicit point coordinates and implicit hexahedral (or quadrilateral) connectivity. Use it for body-fitted structured meshes, e.g. multi-block CFD grids exported block by block. For axis-aligned grids use readRectilinearGrid or readImageData; for arbitrary cells use readUnstructuredGrid.

Common mistakes and assumptions:

  • Coordinates are in whatever unit the writer used; nothing is converted.
  • Every array is read; use the generated pvXMLStructuredGridReader binding to select arrays on large grids.

Native constructor: XMLStructuredGridReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the VTK XML structured grid data format. The standard extension is .vts. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readStructuredGrid",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readSurface#

Reads one VTK XML polydata file (.vtp): polygonal surfaces, lines and vertices with point and cell arrays, such as extracted boundaries, slices or streamlines saved earlier. Use it to reopen surface artifacts, for instance in a later workflow that renders or measures them. Use readParallelPolyData for partitioned .pvtp output and readUnstructuredGrid for volume meshes.

Common mistakes and assumptions:

  • Only one file is read; reopen a time series through its .pvd collection with pvPVDReader, or use pvXMLPolyDataReader with several files.

Native constructor: XMLPolyDataReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readSurface",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

readUnstructuredGrid#

Reads one VTK XML unstructured grid file (.vtu) into vtkUnstructuredGrid, with any mix of cell types (tetrahedra, hexahedra, wedges, polyhedra) and all point and cell arrays. Use it to reopen volume meshes exported by Schemaxis, Gmsh or a solver; it is the reader covered by Schemaxis's reader fixture. Use pvXMLUnstructuredGridReader when you need array selection or a file series, and readParallelUnstructuredGrid for .pvtu output.

Common mistakes and assumptions:

  • Coordinates are in whatever unit the writer used; nothing is converted.

Native constructor: XMLUnstructuredGridReader. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
files The list of files to be read by the reader. Each file is expected to be in the VTK XML unstructured grid data format. The standard extension is .vtu. If more than one file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide one file per time step. Fixed at construction; cannot vary per visit. {"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":1} required ["REPLACE_WITH_VALUE"]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "readUnstructuredGrid",
  "options": {
    "files": [
      "REPLACE_WITH_VALUE"
    ]
  }
}

reflect#

Mirrors the input across an axis-aligned plane and outputs an unstructured grid (a composite input gives a multiblock of unstructured grids) holding the mirrored copy, plus the original when copyInput is true. Use it to rebuild a full model from a half- or quarter-symmetry simulation, or to mirror a part for display. The plane is x, y or z = centre (Schemaxis default plane X at 0) or one face of the input's bounding box (X Min to Z Max). Vector and tensor arrays such as velocity are mirrored with the geometry because ParaView's FlipAllInputArrays stays at its default (on); scalars are copied unchanged.

Common mistakes and assumptions:

  • The two halves are appended, not merged: points on the mirror plane are duplicated and the halves are not connected. Run cleanGrid afterwards when connectivity matters, e.g. before surface, connectivity or point-based gradients.
  • Image data, rectilinear and structured grids become an unstructured grid, which can need much more memory than the input.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a sphere with the default options; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Reflect. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
plane The value of this property determines which plane to reflect across. If the value is X, Y, or Z, the value of the Center property determines where the plane is placed along the specified axis. The other six options (X Min, X Max, etc.) place the reflection plane at the specified face of the bounding box of the input dataset. {"type":"enum","values":["X Min","Y Min","Z Min","X Max","Y Max","Z Max","X","Y","Z"]} "X" "X"
centre If the value of the Plane property is X, Y, or Z, then the value of this property specifies the center of the reflection plane. {"type":"number"} 0 0
copyInput When true, the output contains the original input plus its mirror image, e.g. the full model rebuilt from a half-model; when false, only the mirrored copy is returned. The two parts are not merged at the mirror plane. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "reflect",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

resample#

Samples the arrays of the input node (port input, native SourceDataArrays) at the points of the mesh node (port mesh, native DestinationMesh). The result has the mesh's geometry with the input's point and cell values interpolated to its points and a vtkValidPointMask array; with passPointArrays (Schemaxis default true) the mesh's own point arrays are kept too. Use it to compare or combine results on a common mesh, e.g. map a CFD field onto a measurement or structural mesh; pvResampleWithDataset exposes the remaining native settings.

Common mistakes and assumptions:

  • The ports are easily swapped: input supplies the values, mesh supplies the geometry.
  • Mesh points outside the input get vtkValidPointMask 0 and unusable values; threshold on the mask before statistics.

Native constructor: ResampleWithDataset. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native SourceDataArrays port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset from which to obtain probe values. The data attributes come from this dataset. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
mesh Required data input for the native DestinationMesh port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the dataset whose geometry will be used in determining positions to probe. The mesh comes from this dataset. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); composite data (multiblock or partitioned collections) (vtkCompositeDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkCompositeDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
passPointArrays Keeps the mesh node's own point arrays (native DestinationMesh) in the output next to the values sampled from the input node. When false, only the sampled arrays and vtkValidPointMask remain on the points. {"type":"boolean"} true true
passCellArrays Keeps the mesh node's own cell arrays (native DestinationMesh) in the output. The input node's cell values are always sampled to the mesh points, never passed as cells. {"type":"boolean"} false false
categorical Control whether the source point data is to be treated as categorical. If the data is categorical, then the resultant data will be determined by a nearest neighbor interpolation scheme rather than by linear interpolation. {"type":"boolean"} false false

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "resample",
  "inputs": {
    "input": "UPSTREAM_input",
    "mesh": "UPSTREAM_mesh"
  }
}

shrink#

Moves the points of every cell towards that cell's centroid (the average of its points) so that cells separate from their neighbours, and outputs an unstructured grid in which no point is shared between cells. It is a mesh-inspection aid that reveals cell shapes, sizes and gaps inside a volume or surface mesh; point and cell arrays travel with the cells. factor is the fraction of each cell's size kept (Schemaxis default 0.8; ParaView's own default is 0.5).

Common mistakes and assumptions:

  • Every shared point is duplicated once per cell, so point count and memory grow several-fold on volume meshes; shrink a slice, surface or extracted subset of a large mesh instead.
  • Do not measure or integrate the result: shrinking scales each cell's area by factor squared and its volume by factor cubed.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a sphere with the default factor; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Shrink. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
factor The value of this property determines how far the points will move. A value of 0 positions the points at the centroid of the cell. A value of 1 leaves them at their original positions. {"type":"number","minimum":0,"maximum":1} 0.8 0.8

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "shrink",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

slice#

Cuts the input with one infinite plane through origin, perpendicular to normal, and returns polygonal data: a surface from a volume mesh, lines from a surface. Point arrays are interpolated onto the cut and cell arrays are copied from the cell each polygon came from, so cell-centred CFD fields appear piecewise constant. Use it for cross-sections of 3-D fields; use clip to keep one side of a volume, contour for an isosurface, probeLine for a 1-D profile, and pvSlice for several parallel offsets or other cut shapes.

Common mistakes and assumptions:

  • origin defaults to [0, 0, 0], not to the centre of your data as in the ParaView GUI. A plane that misses the data gives empty geometry, which Schemaxis reports as EMPTY_GEOMETRY; set origin inside the dataset bounds.
  • Hyper tree grid input is refused with INPUT_TRAIT_MISMATCH (recovery: use pvSlice): this operation sets only ParaView's SliceType, whereas a hyper tree grid is cut by the separate HyperTreeGridImplicitFunction, so origin and normal would have no effect on it.
  • Native acceptance (examples/schemaxis/acceptance.py) checks that slices lie on the requested plane and that integrals over a wavelet slice match analytic values; crinkle output and real CFD meshes are not separately checked.

Native constructor: Slice. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). A hyper-tree grid is refused with INPUT_TRAIT_MISMATCH when the node updates; use pvSlice for it. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{"topology":["structured","unstructured"]},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"},"recovery":"use pvSlice, which exposes the native hyper-tree-grid cut function"}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
origin A point lying on the cutting plane, expressed as [X, Y, Z] in dataset coordinates. Moving it along the normal moves the cut. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
normal Direction perpendicular to the plane. Use z+ for an XY plane, y+ for XZ, and x+ for YZ; a nonzero XYZ vector or declared direction object also works. {"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}]} [1,0,0] [1,0,0]
crinkle Keep whole intersected cells instead of interpolating a flat geometric cut. This is useful for inspecting mesh cells but changes the output geometry. {"type":"boolean"} false false
triangulate Split the interpolated cut polygons into triangles. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "slice",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

smooth#

Applies Laplacian smoothing to a polygonal surface: each iteration moves every point a small step towards the average of its connected neighbours. The output is polygonal data with the same points and connectivity at smoother positions, and arrays are passed unchanged. Use it to reduce faceting or noise on scanned, marching-cubes or STL surfaces before rendering or curvature. Input must be vtkPolyData; run surface first on volume meshes.

Common mistakes and assumptions:

  • Laplacian smoothing shrinks surfaces and rounds sharp features; compare volumes or key dimensions with the input before measuring the result.
  • VTK's relaxation factor (0.01) is not exposed, so 20 iterations move points only slightly; raise iterations for stronger smoothing.
  • Feature edges are not protected and open boundaries are smoothed too (VTK defaults: feature-edge smoothing off, boundary smoothing on); neither smooth nor pvSmooth exposes these switches.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a sphere with the default options; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Smooth. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
iterations This property sets the maximum number of smoothing iterations to perform. More iterations produce better smoothing. {"type":"integer","minimum":0} 20 20
convergence The value of this property limits the maximum motion of any point. It is expressed as a fraction of the length of the diagonal of the bounding box of the input dataset. If the maximum point motion during a smoothing iteration is less than the value of this property, the smoothing operation terminates. {"type":"number","minimum":0} 0 0

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "smooth",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

sphere#

Creates a triangulated polygonal sphere (vtkPolyData with point normals) of given radius about centre, with its poles on the z axis. resolution sets the number of longitude divisions around z (Schemaxis default 24, ParaView's own default 8); latitude divisions are fixed at 24 by Schemaxis. Use it as a marker, a target mesh for resample, a seed surface for streamTracer or simple test geometry; its coordinates are in the units of the data it is combined with.

Common mistakes and assumptions:

  • Latitude resolution (PhiResolution) is fixed at 24, so a very high resolution gives long thin facets; use pvSphere to set ThetaResolution and PhiResolution together or to make a partial sphere.
  • The facets lie inside the true sphere, so the surface area and enclosed volume are slightly smaller than the analytic values, noticeably so at low resolution.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, with the default options; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Sphere. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
centre This property specifies the 3D coordinates for the center of the sphere. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
radius This property specifies the radius of the sphere. {"type":"number","minimum":0,"exclusiveMinimum":true} 1 1
resolution The value of this property represents the number of divisions between Start Theta and End Theta around the sphere. (See the Start Theta and End Theta properties.) The theta divisions are similar to longitude lines on the earth. The higher the resolution, the closer the approximation will come to a sphere, and the more polygons there will be. {"type":"integer","minimum":3} 24 24

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "sphere"
}

streamTracer#

Integrates streamlines of a steady vector field from the points of a separate seed dataset and returns polygonal data made of polylines. Connect the flow dataset to input and any point-producing node (line, sphere, a slice) to seed; every seed point starts a trace. Input point arrays are interpolated onto the lines and ParaView adds IntegrationTime, Vorticity, Rotation and AngularVelocity point arrays and a ReasonForTermination cell array. Point vectors are interpolated along the trace. A cell vector array (association CELLS) is traced as constant within each cell, but ParaView's input domain also requires some three-component point array on the input, so a cell-only input fails INPUT_DOMAIN_MISMATCH at update. Convert cell-centred CFD velocity with cellToPoint for the usual smooth traces. The integrator stays at ParaView's Runge-Kutta 4-5 with step lengths in cell lengths. Use pvStreamTracerWithCustomSource to change the integrator, step unit or terminal speed, and pvStreamTracer for ParaView's built-in seed shapes.

Common mistakes and assumptions:

  • These are instantaneous streamlines at the selected time, not pathlines or particle tracks through changing timesteps.
  • maximumLength (Schemaxis default 20) is an absolute arc length in dataset units, not a fraction of the domain; scale it to your geometry, or lines in a large domain stop early.
  • Empty or truncated lines usually mean seeds outside the flow cells, the wrong vector array, or speed below ParaView's terminal speed (1e-12). ReasonForTermination tells why each line stopped: 1 left the domain, 4 maximum length, 5 maximum steps, 6 terminal speed.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, tracing a uniform analytic velocity from a line of seeds; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: StreamTracerWithCustomSource. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input The updated dataset containing the velocity vector. This is the flow field, not the seed line. True one object data {"compatibility":"native-domain-checked","composite":true,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}
seed A separate node whose points start the streamlines, usually a Line source. Select the line node ID here. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
vectors Two entries: the association token and the vector array name. For point-centred velocity U use ["POINTS", "U"]. Select a vector, not its scalar magnitude. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
direction FORWARD follows the vector orientation, BACKWARD goes against it, and BOTH traces from each seed in both directions. {"type":"enum","values":["FORWARD","BACKWARD","BOTH"]} "FORWARD" "FORWARD"
maximumLength Upper limit on the arc length of each integrated trajectory. Integration may stop earlier at a dataset boundary, low speed or the step limit. {"type":"number","minimum":0,"exclusiveMinimum":true} 20 20
maximumSteps Upper limit on integration steps for each streamline. Reaching this limit can truncate a trajectory before its maximum length. {"type":"integer","minimum":1} 2000 2000
initialStep Initial integration step size. Its units depend on native IntegrationStepUnit; it is not necessarily a distance in metres. The curated operation leaves the integrator and step unit at native defaults. {"type":"number","minimum":0,"exclusiveMinimum":true} 0.2 0.2

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "streamTracer",
  "inputs": {
    "input": "UPSTREAM_input",
    "seed": "UPSTREAM_seed"
  },
  "options": {
    "vectors": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ]
  }
}

surface#

Extracts the outer boundary surface of any dataset as polygonal data: the exterior faces of volume cells plus any 2-D, line and vertex cells already present. Use it to turn a volume mesh into a surface for rendering, normals, featureEdges, decimate or surface export, or to see the whole boundary of a CFD domain (walls, inlets and outlets together). Cell arrays are copied from the adjacent cell to each face and point arrays are passed; nothing is interpolated.

Common mistakes and assumptions:

  • Interior faces are removed, so use slice or clip to see inside. Composite data is surfaced block by block, so faces between blocks remain.
  • Cell values on the surface are those of the adjacent volume cell, not boundary-condition values; for OpenFOAM patch values select the patch regions in foam instead.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on point data derived from the wavelet; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: ExtractSurface. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "surface",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

temporalStatistics#

Computes, for every point and cell array of a time-dependent input, its average, minimum, maximum and population standard deviation over all input time steps, which the filter requests itself. The output has the input's type and geometry, no time, and arrays named <name>_average, <name>_minimum, <name>_maximum and <name>_stddev (other arrays are not kept). Every step is weighted equally regardless of time spacing, so this is not a time integral. Schemaxis enables all four statistics by default; use pvTemporalStatistics only if you want the generated binding with native option names.

Common mistakes and assumptions:

  • Unequal time steps bias the average; resample time first if the spacing varies.
  • Every time step is read and processed, which can take long on large series; restrict the input time range first.
  • The mesh must keep the same points and cells over time; on changing meshes the statistics are meaningless.

Native constructor: TemporalStatistics. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: Set the input to the Temporal Statistics filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
average Compute the average of each point and cell variable over time. {"type":"boolean"} true true
minimum Compute the minimum of each point and cell variable over time. {"type":"boolean"} true true
maximum Compute the maximum of each point and cell variable over time. {"type":"boolean"} true true
standardDeviation Compute the standard deviation of each point and cell variable over time. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "temporalStatistics",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

threshold#

Keeps the cells of a mesh whose selected point or cell scalar lies inside the inclusive range [lower, upper], producing an unstructured grid. Schemaxis fixes ParaView's ThresholdMethod to Between, requires all three options, checks that lower does not exceed upper and that the named array exists with the stated association. Use it to isolate a region such as hot gas or a recirculation zone; use pvThreshold for inverted, one-sided or component-wise tests.

Common mistakes and assumptions:

  • For point arrays ParaView's AllScalars default (true) applies: a cell is kept only if all of its points are in range, which shrinks the region compared with a cell-array threshold.
  • Cells are kept whole, so the boundary is stepped; use contour or clip for a smooth iso-boundary.

Native constructor: Threshold. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. ParaView: This property specifies the input to the Threshold filter. Accepted data: any dataset (meshes, grids, point sets) (vtkDataSet); hyper-tree grids (adaptive AMR-like trees) (vtkHyperTreeGrid). The input needs at least one point- or cell-centred array. True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkDataSet","vtkHyperTreeGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
field Select the association and scalar array used to decide which cells are retained. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
lower The lower limit of the retained scalar interval. The lower limit must not exceed the upper limit. {"type":"number"} required 1
upper The upper limit of the retained scalar interval. The lower limit must not exceed the upper limit. {"type":"number"} required 1

Cross-option checks:

[
  {
    "kind": "ordered",
    "options": [
      "lower",
      "upper"
    ]
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "threshold",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "field": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ],
    "lower": 1,
    "upper": 1
  }
}

transform#

Applies a linear transform to the point coordinates: scale, then rotation, then translation, all about the coordinate origin [0, 0, 0]. Vectors and normals are transformed with the geometry (every three-component array while allVectors is true). Polygonal, unstructured and structured grids keep their type; image data and rectilinear grids become an explicit-point dataset. Use it to position, orient or rescale geometry, e.g. scale [0.001, 0.001, 0.001] to convert millimetre coordinates to metres.

Common mistakes and assumptions:

  • Rotation and scaling act about the origin, not the dataset centre, so an object away from the origin also moves. Translate it to the origin first, or use pvTransform with RotateAroundOriginTransform.
  • Transformed vector arrays are rotated and scaled too: a millimetre-to-metre scale also multiplies velocity-like vectors by 0.001. Field values are never unit-converted.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, translating a sphere by [1, 2, 3]; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Transform. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
translate Displacement [dx, dy, dz] added to every point after scaling and rotation, in dataset coordinate units. Translation does not change vector arrays. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
rotate Rotation angles in degrees about the x, y and z axes through the origin [0, 0, 0]. vtkPVTransform composes RotateZ, RotateX, RotateY, so the points are turned about y first, then x, then z (fixed axes), after scaling and before translation. Positive angles follow the right-hand rule about each positive axis. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
scale Factors [sx, sy, sz] multiplying the x, y and z coordinates about the origin, applied before rotation and translation. Equal factors change size or units, e.g. [0.001, 0.001, 0.001] for millimetres to metres; unequal factors stretch the geometry. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [1,1,1] [1,1,1]
allVectors If off, only Vectors and Normals will be transformed. If on, all three-component data arrays (considered as 3D vectors) will be transformed. All other arrays won't be flipped and will only be copied. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "transform",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

triangulate#

Converts polygonal data so that every polygon and triangle strip becomes triangles and polylines become single line segments; vertices are kept. The output is vtkPolyData on the same points, with cell values copied from each parent cell. Use it before operations or exports that need triangles, such as decimate or STL output. It accepts only polygonal input: run surface first for volume data, or use pvTetrahedralize to split volume cells into tetrahedra.

Common mistakes and assumptions:

  • The cell count grows (a quadrilateral becomes two triangles) and cell values are repeated on each piece, so per-cell counts and cell-based statistics change, while point data is unaffected.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a wavelet slice; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Triangulate. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

No authored options.

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "triangulate",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

tube#

Builds a polygonal tube of constant radius around each line or polyline of polygonal input, typically streamlines from streamTracer, so that thin lines become visible shaded geometry in images and exports. The output is vtkPolyData, and input point arrays are carried onto the tube surface so it can be coloured by the same fields. Schemaxis assigns radius 0.1, 12 sides and capped ends; ParaView's radius variation stays off, so use pvTube for tubes whose radius follows a scalar or vector.

Common mistakes and assumptions:

  • radius is an absolute length in dataset units: 0.1 vanishes on a 100 m domain and swamps a 1 mm one. ParaView's GUI starts from 1% of the input extent, a reasonable first choice.
  • Lines with repeated consecutive points are not tubed; run clean first if segments are missing.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on streamlines of a uniform analytic field; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: Tube. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: polygonal data (surfaces, lines or vertices) (vtkPolyData). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPolyData"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
radius Geometric tube radius around the centreline. Choose it relative to the case size; it does not change the integrated flow trajectory. {"type":"number","minimum":0,"exclusiveMinimum":true} 0.1 0.1
sides Number of polygonal sides around each tube. More sides make it look rounder and increase geometry size. {"type":"integer","minimum":3} 12 12
capping Close the ends of each generated tube. {"type":"boolean"} true true

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "tube",
  "inputs": {
    "input": "UPSTREAM_input"
  }
}

warpScalar#

Displaces each point along a direction by scale times a point scalar (new position = point + scale x value x direction), turning a field on a flat surface into a relief or carpet plot, or moving a surface by a normal displacement. With useNormal true (Schemaxis default) every point moves along the same normal (default z+); with useNormal false the input's point normals are used when present. The output keeps the input type, except that image data and rectilinear grids become a structured grid; all arrays are carried along.

Common mistakes and assumptions:

  • The warp distance is in dataset units: choose scale so that the field range times scale is a modest fraction of the geometry size, otherwise the relief dwarfs or hides the shape.
  • Schemaxis normalizes normal, so its length does not change the displacement; express any magnification through scale.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a planar slice with a linear field; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: WarpByScalar. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
field Two entries naming the scalar that sets the displacement: the association token POINTS and the array name, e.g. ["POINTS", "height"]. Each point moves by scale times its value along the warp direction, so negative values move points the opposite way. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
scale The scalar value at a given point is multiplied by the value of this property to determine the magnitude of the change vector for that point. {"type":"number"} 1 1
normal Direction along which points are displaced, as an axis token, a vector or an azimuth/elevation object; Schemaxis normalizes it to unit length. It applies to every point while useNormal is true, and when useNormal is false only if the input has no point normals. {"type":"union","title":"direction","summary":"An axis token, a vector, or an azimuth and elevation about an up axis","options":[{"type":"string","title":"axis token such as 'x+' or 'z-'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},{"type":"object","title":"direction object","properties":{"axis":{"type":"string","summary":"Axis token such as 'x+'"},"azimuth":{"type":"number","minimum":-360,"maximum":360,"summary":"Degrees about the up axis from the reference axis"},"elevation":{"type":"number","minimum":-180,"maximum":180,"summary":"Degrees tilted from the plane perpendicular to up"},"vector":{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3},"up":{"type":"union","title":"up direction","options":[{"type":"string","title":"axis token such as 'z+'"},{"type":"array","title":"vector [x, y, z]","items":{"type":"number"},"minItems":3,"maxItems":3}]}}}]} [0,0,1] [0,0,1]
useNormal When true, every point moves along normal and any point normals in the input are ignored. Set it to false to displace a curved surface along its own point normals, e.g. a normal-displacement field on a hull; normal is then used only if the input has no point normals. {"type":"boolean"} true true

Cross-option checks:

[
  {
    "kind": "firstItem",
    "option": "field",
    "values": [
      "POINTS"
    ],
    "code": "INVALID_ASSOCIATION",
    "message": "warpScalar reads the selected array per point; the CELLS association is not supported",
    "recovery": "name a POINTS array; convert cell data first with cellToPoint"
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "warpScalar",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "field": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ]
  }
}

warpVector#

Moves every point by scale times a three-component point vector (new position = point + scale x vector), typically to show a structural displacement field or exaggerate a deformation mode. The output keeps the input type (image data and rectilinear grids become structured grids) and carries all arrays. With scale 1 and a displacement in the same length units as the coordinates the result is the true deformed shape; warping by a velocity is only a visual distortion.

Common mistakes and assumptions:

  • The displacement must be in the coordinate units: a displacement in millimetres on a mesh in metres needs scale 0.001 for the true shape.
  • Large scales can fold or invert cells; do not compute volumes or mesh quality on an exaggerated warp.
  • Schemaxis's serial native acceptance run (examples/schemaxis/extended-coverage.json) executes this operation once, on a wavelet with a uniform vector field and scale 0.25; it does not check this operation's output values, so inspect the result on your own data.

Native constructor: WarpByVector. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

Port Meaning / native port Required Multiplicity Kind Contract
input Required data input for the native Input port. Give the name of the upstream node to connect, or a {node, port} object to use another of its output ports. Accepted data: explicit-point datasets (polygonal, unstructured or structured grids) (vtkPointSet); image data (uniform rectilinear grids) (vtkImageData); rectilinear grids (vtkRectilinearGrid). True one object data {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":["vtkPointSet","vtkImageData","vtkRectilinearGrid"],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
vectors Two entries naming the displacement vectors: the association token POINTS and the name of a three-component point array, e.g. ["POINTS", "displacement"]. Each point moves by scale times its vector. {"type":"array","items":{"type":"string","minLength":1},"minItems":2,"maxItems":2} required ["REPLACE_WITH_VALUE","REPLACE_WITH_VALUE"]
scale Each component of the selected vector array will be multiplied by the value of this property before being used to compute new point coordinates. {"type":"number"} 1 1

Cross-option checks:

[
  {
    "kind": "firstItem",
    "option": "vectors",
    "values": [
      "POINTS"
    ],
    "code": "INVALID_ASSOCIATION",
    "message": "warpVector reads the selected array per point; the CELLS association is not supported",
    "recovery": "name a POINTS array; convert cell data first with cellToPoint"
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "warpVector",
  "inputs": {
    "input": "UPSTREAM_input"
  },
  "options": {
    "vectors": [
      "REPLACE_WITH_VALUE",
      "REPLACE_WITH_VALUE"
    ]
  }
}

wavelet#

Creates a synthetic uniform image (vtkImageData) whose point array RTData combines a Gaussian peak of height maximum with sinusoidal terms along x, y and z. With the Schemaxis defaults it is a 21 x 21 x 21-point grid with unit spacing spanning -10 to 10 on each axis. Use it as a self-contained input to try slice, contour, clip, streamTracer or scene settings without a real case; its values have no physical meaning or units.

Common mistakes and assumptions:

  • Each extent minimum must be smaller than its maximum, so the curated wavelet cannot produce a 2-D image; use pvWavelet for planar or subsampled images and to change frequencies, amplitudes or the Gaussian width.
  • RTData is a scalar; derive test vectors with calculator (e.g. iHat), as the native acceptance example examples/schemaxis/extended-coverage.json does before its analytic integral checks.

Native constructor: Wavelet. Identity: curated binding. Role: pipeline. Output kinds: ["data"].

Inputs#

No connected inputs (source/resource).

Options#

Key Meaning / native assignment Type and constraints Default / required Example value
extent The six values in this property indicate the X, Y, and Z extent of the output data. The first two values represent the minimum and maximum X indices, the next two are the minimum and maximum Y indices, and the last two are the minimum and maximum Z indices. {"type":"array","items":{"type":"integer"},"minItems":6,"maxItems":6} [-10,10,-10,10,-10,10] [-10,10,-10,10,-10,10]
centre Centre of the Gaussian and origin of the wave coordinates, in grid-index units: for each point, x, y and z are the offsets of its grid index from Center, divided by the extent width on that axis, and the Gaussian depends on their length r. It is not in physical units. ParaView's own text refers to "the equation" it prints, which multiplies the terms; the filter adds them to the Gaussian. {"type":"array","items":{"type":"number"},"minItems":3,"maxItems":3} [0,0,0] [0,0,0]
maximum Height of the Gaussian term of RTData at centre. It is not the maximum of the output: sine and cosine terms (ParaView amplitudes 10, 18 and 5) are added to it, so RTData can exceed it. Raising it strengthens the central peak relative to the ripples. {"type":"number"} 255 255

Cross-option checks:

[
  {
    "kind": "bounds",
    "option": "extent"
  }
]

Execution contract:

{
  "mode": "serial",
  "performance": "unknown"
}

Syntax example#

Place in nodes. Data outputs may be selected by a scene; resource outputs must be connected to a compatible consumer.

{
  "id": "result",
  "filter": "wavelet"
}