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

Paraview operation reference

Generated from the current declarations. Do not edit this file by hand.

Types, limits and defaults below describe resolved values. Runtime expressions must produce these types. Unknown options are rejected; defaults apply only when omitted. Constructor options must be constant after document composition.

Index#

append, appendGeometry, calculator, cellSize, cellToPoint, clean, cleanGrid, clip, cone, connectivity, contour, curvature, cylinder, decimate, delaunay2D, delaunay3D, disk, edges, elevation, extractBlock, extractSubset, featureEdges, foam, generateIds, gradient, group, integrate, line, merge, normals, outline, passArrays, plane, pointToCell, probeLine, pvADIOS2CoreImageReader, pvADIOS2VTXReader, pvAMRConnectivity, pvAMRContour, pvAMRDualClip, pvAMRFragmentIntegration, pvAMRFragmentsFilter, pvAMRGaussianPulseSource, pvAMReXBoxLibGridReader, pvAMReXBoxLibParticlesReader, pvANLHaloFinder, pvANLSubhaloFinder, pvAVSUCDReader, pvAdaptiveCosmoCore, pvAdaptiveResampleToImage, pvAddFieldArrays, pvAggregateDataset, pvAlignImageOrigins, pvAngularPeriodicFilter, pvAnimateModes, pvAnnotateAttributeData, pvAnnotateGlobalData, pvAnnotateSelection, pvAnnotateTime, pvAnnotateTimeFilter, pvAppendArcLength, pvAppendAttributes, pvAppendDatasets, pvAppendGeometry, pvAppendLocationAttributes, pvAppendMolecule, pvAppendReduce, pvAppendSelections, pvArrow, pvAxes, pvAxisAlignedSlice, pvBDFReader, pvBYUReader, pvBlockIds, pvBlockScalars, pvBlockSelectionSource, pvBlockSelectorsSelectionSource, pvBoundaryMeshQuality, pvBoundingRuler, pvBox, pvCGNSSeriesReader, pvCMLMoleculeReader, pvCONVERGECFDCGNSReader, pvCONVERGECFDReader, pvCSVReader, pvCalculator, pvCellCenters, pvCellDatatoPointData, pvCellGridElevation, pvCellGridProbe, pvCellSize, pvCesium3DTilesReader, pvCityGMLReader, pvClean, pvCleanCellstoGrid, pvCleantoGrid, pvClientServerMoveData, pvClip, pvClipClosedSurface, pvColorByArray, pvCompositeCellGridReader, pvCompositeDataIDSelectionSource, pvComputeConnectedSurfaceProperties, pvComputeDerivatives, pvComputeMoleculeBonds, pvComputeQuartiles, pvComputeSides, pvConduit, pvCone, pvConnectedSurfaceProperties, pvConnectivity, pvContingencyStatistics, pvContour, pvConvertAMRdatasettoMultiblock, pvConvertIntoMolecule, pvConvertPolyhedralCells, pvConvertSelection, pvConvertToCellGrid, pvConvertToMultiBlock, pvConvertToPartitionedDataSetCollection, pvConvertToPointCloud, pvCoordinates, pvCosmoReader, pvCountCellFaces, pvCountCellVertices, pvCriticalTime, pvCrop, pvCurvature, pvCylinder, pvD3, pvDEMReader, pvDICOMReaderSingleFile, pvDICOMReaderdirectory, pvDataObjectGenerator, pvDateToNumeric, pvDecimate, pvDecimatePolyline, pvDeflectNormals, pvDelaunay2D, pvDelaunay3D, pvDescriptiveStatistics, pvDisk, pvDistributePoints, pvDistributedTrivialProducer, pvENZOAMRParticlesReader, pvERFHDF5datareader, pvElevation, pvEllipse, pvEnSightMasterServerReader, pvEnSightReader, pvEnsembleDataReader, pvEnvironmentAnnotation, pvEnzoReader, pvEqualizerFilter, pvEvenlySpacedStreamlines2D, pvExodusIIReader, pvExtractAMRBlocks, pvExtractAttributes, pvExtractBlock, pvExtractCTHParts, pvExtractCellsAlongLine, pvExtractCellsAlongLinesCustomSource, pvExtractCellsByRegion, pvExtractCellsByType, pvExtractComponent, pvExtractEdges, pvExtractEnclosedPoints, pvExtractGhostCells, pvExtractLocation, pvExtractParticlesOverTime, pvExtractRegionSurface, pvExtractSelection, pvExtractSelectioninternal, pvExtractSubset, pvExtractSubsetWithSeed, pvExtractSurface, pvExtractTimeSteps, pvFDSReader, pvFFTOfSelectionOverTime, pvFLASHAMRParticlesReader, pvFacetReader, pvFastUniformGrid, pvFeatureEdges, pvFidesJSONReader, pvFidesReader, pvFieldArraysFromFile, pvFieldDatatoAttribute, pvFiniteElementFieldDistributor, pvFlashReader, pvFluentCFFCaseReader, pvFluentCaseReader, pvForceStaticMesh, pvForceTime, pvFrustumSelectionSource, pvGDALRasterReader, pvGDALVectorReader, pvGaussianCubeReader, pvGaussianResampling, pvGenerateGlobalIds, pvGenerateIds, pvGenerateProcessIds, pvGenerateQuadraturePoints, pvGenerateQuadratureSchemeDictionary, pvGenerateSpatioTemporalHarmonics, pvGenerateSurfaceNormals, pvGenerateSurfaceTangents, pvGenerateTimeSteps, pvGenericIOMultiBlockReader, pvGenericIOReader, pvGeometryFilter, pvGhostCells, pvGhostCellsGenerator, pvGlobalIDSelectionSource, pvGlobalPointAndCellIds, pvGlyph, pvGlyphWithCustomSource, pvGradient, pvGradientMagnitude, pvGroupDatasets, pvGroupTimeSteps, pvH5PartReader, pvHDF5RageReader, pvHDRReader, pvHierarchicalDataIDSelectionSource, pvHierarchicalFractal, pvHistogram, pvHistogram2D, pvHyperTreeGrid, pvHyperTreeGridAxisReflection, pvHyperTreeGridCellCenters, pvHyperTreeGridDepthLimiter, pvHyperTreeGridEvaluateCoarse, pvHyperTreeGridFeatureEdgesFilter, pvHyperTreeGridGeometryFilter, pvHyperTreeGridGhostCellsGenerator, pvHyperTreeGridRandom, pvHyperTreeGridReader, pvHyperTreeGridToDualGrid, pvHyperTreeGridToUnstructuredGrid, pvHyperTreeGridVisibleLeavesSize, pvIDSelectionSource, pvIGESReader, pvIOSSCellGridReader, pvIOSSReader, pvImageDataToAMR, pvImageDataToUniformGrid, pvImageDatatoPointSet, pvImageReader, pvImageShrink, pvInSituParticlePath, pvIntegrateVariables, pvInterpolatetoQuadraturePoints, pvIntersectFragments, pvIsoVolume, pvJPEGSeriesReader, pvKMeans, pvLANLFOFSODHaloFinder, pvLSDynaReader, pvLegacyParticlePath, pvLegacyStreakLine, pvLegacyVTKReader, pvLevelScalarsOverlappingAMR, pvLine, pvLinearCellExtrusion, pvLinearExtrusion, pvLocationSelectionSource, pvLogo, pvLoopSubdivision, pvMFIXReader, pvMPIMoveData, pvMRCSeriesReader, pvMandelbrot, pvMaskPoints, pvMaterialInterfaceFilter, pvMedian, pvMergeBlocks, pvMergeTime, pvMergeVectorComponents, pvMeshQuality, pvMetaFileSeriesReader, pvMinMax, pvMinkowskiFilter, pvMoleculeToLines, pvMotionFXCFGReader, pvMultiResGenericIO, pvMulticorrelativeStatistics, pvNek5000Reader, pvNetCDFCAMreader, pvNetCDFMPASreader, pvNetCDFPOPreader, pvNetCDFReader, pvNetCDFUGRIDreader, pvNetworkImageSource, pvNormalGlyphs, pvNrrdReader, pvOMETIFFChannelCalculator, pvOMETIFFReader, pvOMFReader, pvObjectFileFormatOFFReader, pvOctreeImagetoPointSet, pvOpenFOAMReader, pvOpenVDBReader, pvOutline, pvOutlineCorners, pvOutlineCurvilinearDataSet, pvOutlineSource, pvOverlappingAMRLevelIds, pvOverlappingCellsDetector, pvPCANormalEstimation, pvPDALReader, pvPDBReader, pvPIOReader, pvPLOT3DMetaFileReader, pvPLOT3DReader, pvPLYReader, pvPNGSeriesReader, pvPTSReader, pvPVDReader, pvPVTrivialProducer, pvPVTrivialProducer2, pvParallelNetCDFPOPreader, pvParticlePath, pvParticleTracer, pvParticlesReader, pvPartitionBalancer, pvPartitionedDataSetCollectionSource, pvPartitionedLegacyVTKReader, pvPassArrays, pvPassThrough, pvPedigreeIDSelectionSource, pvPerlinNoise, pvPhastaReader, pvPlane, pvPlotData, pvPlotDataOverTime, pvPlotGlobalVariablesOverTime, pvPlotOnIntersectionCurves, pvPlotOnSortedLines, pvPlotOverLine, pvPlotOverLinesFromCustomSource, pvPlotSelectionOverTime, pvPointAndCellIds, pvPointDatasetInterpolator, pvPointDatatoCellData, pvPointLineInterpolator, pvPointPlaneInterpolator, pvPointSetToOctreeImage, pvPointSource, pvPointVolumeInterpolator, pvPolyLineSource, pvPolyPointSource, pvPolylineLength, pvPrincipalComponentAnalysis, pvProbeLocation, pvProcessIdScalars, pvProcessIds, pvProtractor, pvQuadricClustering, pvRTXMLPolyDataReader, pvRandomAttributes, pvRandomVectors, pvRectilinearDatatoPointSet, pvRectilinearGridConnectivity, pvRectilinearGridGeometryFilter, pvRedistributeDataSet, pvReductionFilter, pvReflect, pvRemoteSourceProxy, pvRemoveGhostInformation, pvRenameArrays, pvResampleAMR, pvResampleToImage, pvResampleToLine, pvResampleWithDataset, pvResourceImageTexture, pvResourcePVLookupTable, pvResourcePiecewiseFunction, pvResourceTexture, pvResourceTransferFunction2D, pvRestartedSimExodusReader, pvRestartedSimSpyPlotReader, pvReverseSense, pvRibbon, pvRotationalExtrusion, pvRuler, pvSAVGReader, pvSEPReader, pvSLACDataReader, pvSLACParticleDataReader, pvSPHDatasetInterpolator, pvSPHLineInterpolator, pvSPHPlaneInterpolator, pvSPHVolumeInterpolator, pvSTEPReader, pvSTLReader, pvScatterPlot, pvSegYReader, pvSelectionQuerySource, pvShrink, pvSlice, pvSliceAlongPolyLine, pvSliceWithPlane, pvSmooth, pvSpatioTemporalHarmonics, pvSpatioTemporalHarmonicsUniformGrid, pvSphere, pvSplineSource, pvSpyPlotReader, pvStitchImageDataWithGhosts, pvStreakLine, pvStreamTracer, pvStreamTracerWithCustomSource, pvSubdivide, pvSuperquadric, pvSurfaceFlow, pvSurfaceNormals, pvSurfaceTangents, pvSurfaceVectors, pvSynchronizeTime, pvTIFFReader, pvTIFFSeriesReader, pvTRUCHASReader, pvTableFFT, pvTableToPoints, pvTableToStructuredGrid, pvTecplotReader, pvTecplotTableReader, pvTemporalArrayOperator, pvTemporalCache, pvTemporalCacheSource, pvTemporalInterpolator, pvTemporalParticlesToPathlines, pvTemporalShiftScale, pvTemporalSmoothing, pvTemporalSnaptoTimeStep, pvTemporalStatistics, pvTensorGlyph, pvTensorPrincipalInvariants, pvTessellate, pvTest3DWidget, pvTetrahedralize, pvText, pvTextureMaptoCylinder, pvTextureMaptoPlane, pvTextureMaptoSphere, pvThreshold, pvThresholdSelectionSource, pvThresholdTable, pvTimeSource, pvTimeStepProgressBar, pvTransform, pvTransposeTable, pvTriangleStrips, pvTriangulate, pvTrivialProducer, pvTube, pvUnstructuredCellTypes, pvUnstructuredNetCDFPOPreader, pvVASPAnimationReader, pvVASPTessellationReader, pvVPICReader, pvVRMLReader, pvVTKHDFReader, pvValidateCells, pvValueSelectionSource, pvVelodyneAMRReader, pvVisItANSYSReader, pvVisItAUXFileReader, pvVisItBOVReader, pvVisItCEAucdReader, pvVisItCMATReader, pvVisItCTRLReader, pvVisItChomboReader, pvVisItClawReader, pvVisItCurve2DReader, pvVisItDDCMDReader, pvVisItDyna3DReader, pvVisItExtrudedVolReader, pvVisItFLASHReader, pvVisItFluentReader, pvVisItGGCMReader, pvVisItGTCReader, pvVisItGULPReader, pvVisItGadgetReader, pvVisItH5NimrodReader, pvVisItImageReader, pvVisItLAMMPSDumpReader, pvVisItLAMMPSStructureReader, pvVisItLinesReader, pvVisItM3DC1Reader, pvVisItM3DReader, pvVisItMFIXCDFReader, pvVisItMFIXReader, pvVisItMM5Reader, pvVisItMiliReader, pvVisItMirandaReader, pvVisItNASTRANReader, pvVisItNek5000Reader, pvVisItNetCDFADAPTReader, pvVisItNetCDFCCSM_MTSDReader, pvVisItNetCDFCCSM_STSDReader, pvVisItNetCDFFVCOMParticleReader, pvVisItNetCDFFVCOM_MTMDReader, pvVisItNetCDFFVCOM_MTSDReader, pvVisItNetCDFFVCOM_STSDReader, pvVisItNetCDFLODIParticleReader, pvVisItNetCDFLODIReader, pvVisItOVERFLOWReader, pvVisItOpenFOAMReader, pvVisItPATRANReader, pvVisItPFLOTRANReader, pvVisItPLOT2DReader, pvVisItPLOT3DReader, pvVisItParaDiSTecplotReader, pvVisItParaDisReader, pvVisItPixieReader, pvVisItPoint3DReader, pvVisItProteinDataBankReader, pvVisItRAWReader, pvVisItSAMRAIReader, pvVisItSARReader, pvVisItSASReader, pvVisItSiloReader, pvVisItSpheralReader, pvVisItTFTReader, pvVisItTSurfReader, pvVisItTecplotBinaryReader, pvVisItTecplotReader, pvVisItTetradReader, pvVisItUNICReader, pvVisItVASPCHGCARReader, pvVisItVASPOUTCARReader, pvVisItVASPPOSCARReader, pvVisItVelodyneReader, pvVisItVsReader, pvVisItXYZReader, pvVisItXmdvReader, pvVolumeOfRevolution, pvVoronoiMergeConnected, pvVortexCores, pvWarpByScalar, pvWarpByVector, pvWavefrontOBJReader, pvWavelet, pvWindBladereader, pvWriteCGNSWriter, pvWriteCSVWriter, pvWriteDataSetCSVWriter, pvWriteDataSetWriter, pvWriteEnSightWriter, pvWriteExodusIIWriter, pvWriteGenericIOWriter, pvWriteHoudiniWriter, pvWriteHyperTreeGridWriter, pvWriteIOSSWriter, pvWriteJPEGWriter, pvWriteJSONImageWriter, pvWriteMetaImageWriter, pvWriteOpenVDBWriter, pvWritePDataSetWriterPolyData, pvWritePDataSetWriterUnstructuredGrid, pvWritePNGWriter, pvWritePOBJWriter, pvWritePPLYWriter, pvWritePSTLWriter, pvWriteSerialHTGMultiBlock, pvWriteTIFFWriter, pvWriteVTKHDFWriter, pvWriteXMLHierarchicalBoxDataWriter, pvWriteXMLImageDataWriter, pvWriteXMLMultiBlockDataWriter, pvWriteXMLPHyperTreeGridWriter, pvWriteXMLPImageDataWriter, pvWriteXMLPPartitionedDataSetWriter, pvWriteXMLPPolyDataWriter, pvWriteXMLPRectilinearGridWriter, pvWriteXMLPStructuredGridWriter, pvWriteXMLPTableWriter, pvWriteXMLPUnstructuredGridWriter, pvWriteXMLPVDWriter, pvWriteXMLPartitionedDataSetCollectionWriter, pvWriteXMLPolyDataWriter, pvWriteXMLRectilinearGridWriter, pvWriteXMLStructuredGridWriter, pvWriteXMLTableWriter, pvWriteXMLUniformGridAMRWriter, pvWriteXMLUnstructuredGridWriter, pvWriteXdmf3Writer, pvWriteXdmfWriter, pvXDMFReader, pvXMLHierarchicalBoxDatareader, pvXMLImageDataReader, pvXMLMultiBlockDataReader, pvXMLPartitionedDatasetCollectionReader, pvXMLPartitionedDatasetReader, pvXMLPartitionedHyperTreeGridReader, pvXMLPartitionedImageDataReader, pvXMLPartitionedPolydataReader, pvXMLPartitionedRectilinearGridReader, pvXMLPartitionedStructuredGridReader, pvXMLPartitionedTableReader, pvXMLPartitionedUnstructuredGridReader, pvXMLPolyDataReader, pvXMLRectilinearGridReader, pvXMLStructuredGridReader, pvXMLTableReader, pvXMLUniformGridAMRReader, pvXMLUnstructuredGridReader, pvXYZReader, pvXdmf3ReaderS, pvXdmf3ReaderT, pvYieldCriteria, pvYoungsMaterialInterface, pva2DGlyph, pva3DText, pvglTFReader, pvopenPMDReader, pvproSTARSTARCDReader, pvspcthhistoryreader, readImageData, readMultiBlock, readPLY, readParallelPolyData, readParallelUnstructuredGrid, readRectilinearGrid, readSTL, readStructuredGrid, readSurface, readUnstructuredGrid, reflect, resample, shrink, slice, smooth, sphere, streamTracer, surface, temporalStatistics, threshold, transform, triangulate, tube, warpScalar, warpVector, wavelet

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 binding: AppendDatasets. Output kind: ["data"].

Input input contract: {"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: none.

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 binding: AppendGeometry. Output kind: ["data"].

Input input contract: {"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: none.

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 binding: Calculator. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: CellSize. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: CellDatatoPointData. Output kind: ["data"].

Input input contract: {"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"}}.

Cross-option requires: [{"when":["allArrays",false],"option":"arrays"}].

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 binding: Clean. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: CleantoGrid. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Clip. Output kind: ["data"].

Input input contract: {"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"}}.

• normal uses the direction conversion described in the input guide.

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 binding: Cone. Output kind: ["data"].

Inputs: none.

• direction uses the direction conversion described in the input guide.

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 binding: Connectivity. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Contour. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Curvature. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Cylinder. Output kind: ["data"].

Inputs: none.

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 binding: Decimate. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Delaunay2D. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Delaunay3D. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Disk. Output kind: ["data"].

Inputs: none.

Cross-option checks: [{"kind":"ordered","options":["innerRadius","outerRadius"]}].

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 binding: ExtractEdges. Output kind: ["data"].

Input input contract: {"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: none.

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 binding: Elevation. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: ExtractBlock. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: ExtractSubset. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: FeatureEdges. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: OpenFOAMReader. Output kind: ["data"].

Inputs: none.

• file is a constructor option.
• caseType is a constructor option.

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 binding: PointAndCellIds. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Gradient. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: GroupDatasets. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: IntegrateVariables. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Line. Output kind: ["data"].

Inputs: none.

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 binding: MergeBlocks. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: SurfaceNormals. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Outline. Output kind: ["data"].

Input input contract: {"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: none.

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 binding: PassArrays. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: Plane. Output kind: ["data"].

Inputs: none.

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 binding: PointDatatoCellData. Output kind: ["data"].

Input input contract: {"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"}}.

Cross-option requires: [{"when":["allArrays",false],"option":"arrays"}].

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 binding: PlotOverLine. Output kind: ["data"].

Input input contract: {"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"}}.

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 binding: ADIOS2CoreImageReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: ADIOS2VTXReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: AMRConnectivity. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AMRContour. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AMRDualClip. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AMRFragmentIntegration. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AMRFragmentsFilter. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AMRGaussianPulseSource. Output kind: ["data"].

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

Inputs: none.

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 binding: AMReXBoxLibGridReader. Output kind: ["data"].

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

Inputs: none.

• FileNames is a constructor option.

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 binding: AMReXBoxLibParticlesReader. Output kind: ["data"].

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

Inputs: none.

• FileNames is a constructor option.

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 binding: ANLHaloFinder. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ANLSubhaloFinder. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AVSUCDReader. Output kind: ["data"].

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

Inputs: none.

• FileNames is a constructor option.

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 binding: AdaptiveCosmoCore. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: AdaptiveResampleToImage. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AddFieldArrays. Output kind: ["data"].

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

Input Input contract: {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}.

onVisit commands: {"Reload":{"command":"Modified","native":"Reload"}}. Invoked in authored order on every selected visit, before updating this node; downstream results are invalidated.

• FileName is a constructor option.

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 binding: AggregateDataset. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AlignImageOrigins. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AngularPeriodicFilter. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AnimateModes. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AnnotateAttributeData. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AnnotateGlobalData. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AnnotateSelection. Output kind: ["data"].

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

Input Input contract: {"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"}}.

Input Selection contract: {"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"}}.

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 binding: AnnotateTime. Output kind: ["data"].

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

Inputs: none.

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 binding: AnnotateTimeFilter. Output kind: ["data"].

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

Input Input contract: {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}.

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 binding: AppendArcLength. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: AppendAttributes. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: AppendDatasets. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AppendGeometry. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: AppendLocationAttributes. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AppendMolecule. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: AppendReduce. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: AppendSelections. Output kind: ["data"].

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

Input Input contract: {"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"}}.

• SelectionColors requires complete groups of 3 values.

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 binding: Arrow. Output kind: ["data"].

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

Inputs: none.

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 binding: Axes. Output kind: ["data"].

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

Inputs: none.

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 binding: AxisAlignedSlice. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: BDFReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: BYUReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: BlockIds. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: BlockScalars. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: BlockSelectionSource. Output kind: ["data"].

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

Inputs: none.

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 binding: BlockSelectorsSelectionSource. Output kind: ["data"].

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

Inputs: none.

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 binding: BoundaryMeshQuality. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: BoundingRuler. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: Box. Output kind: ["data"].

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

Inputs: none.

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 binding: CGNSSeriesReader. Output kind: ["data"].

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

Inputs: none.

• FileNames is a constructor option.

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 binding: CMLMoleculeReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: CONVERGECFDCGNSReader. Output kind: ["data"].

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

Inputs: none.

• FileNames is a constructor option.

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 binding: CONVERGECFDReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: CSVReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: Calculator. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CellCenters. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CellDatatoPointData. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CellGridElevation. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CellGridProbe. Output kind: ["data"].

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

Input Input contract: {"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 Source contract: {"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"}}.

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 binding: CellSize. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: Cesium3DTilesReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: CityGMLReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: Clean. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CleanCellstoGrid. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: CleantoGrid. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ClientServerMoveData. Output kind: ["data"].

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

Input Input contract: {"compatibility":"native-domain-checked","composite":null,"cost":{"basis":"no benchmark","conversion":"none inserted","rating":"unknown"},"nativeTypes":[],"requirements":{},"traits":{"contiguity":"unknown","indexing":"unknown","iteration":"unknown"}}.

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 binding: Clip. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ClipClosedSurface. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ColorByArray. Output kind: ["data"].

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

Input Input contract: {"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"}}.

Input LookupTable contract: {"compatibility":"native-proxy-group","cost":{"basis":"no benchmark","rating":"unknown"},"nativeGroup":"lookup_tables"}.

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 binding: CompositeCellGridReader. Output kind: ["data"].

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

Inputs: none.

• FileName is a constructor option.

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 binding: CompositeDataIDSelectionSource. Output kind: ["data"].

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

Inputs: none.

• IDs requires complete groups of 3 values.

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 binding: ComputeConnectedSurfaceProperties. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ComputeDerivatives. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ComputeMoleculeBonds. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ComputeQuartiles. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ComputeSides. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: Conduit. Output kind: ["data"].

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

Inputs: none.

Options: none.

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 binding: Cone. Output kind: ["data"].

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

Inputs: none.

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 binding: ConnectedSurfaceProperties. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: Connectivity. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ContingencyStatistics. Output kind: ["data"].

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

Input Input contract: {"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"}}.

Input ModelInput contract: {"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"}}.

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 binding: Contour. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ConvertAMRdatasettoMultiblock. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ConvertIntoMolecule. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: ConvertPolyhedralCells. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ConvertSelection. Output kind: ["data"].

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

Input DataInput contract: {"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 Input contract: {"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"}}.

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 binding: ConvertToCellGrid. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ConvertToMultiBlock. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ConvertToPartitionedDataSetCollection. Output kind: ["data"].

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

Input Input contract: {"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: none.

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 binding: ConvertToPointCloud. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: Coordinates. Output kind: ["data"].

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

Input Input contract: {"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"}}.

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 binding: CosmoReader. Output kind: ["data"].

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

Inputs: none.