Skip to content

Planar compute result API

pyvoro2.planar.result

Structured result objects for wrapper-level planar convenience APIs.

PlanarComputeResult dataclass

Structured return value for :func:pyvoro2.planar.compute.

Attributes:

Name Type Description
cells list[dict[str, Any]]

Raw planar cell dictionaries returned by the compute wrapper after any temporary internal geometry has been stripped according to the caller's requested output flags.
tessellation_diagnostics TessellationDiagnostics | None

Wrapper-computed tessellation diagnostics, if requested directly or needed for tessellation_check.
normalized_vertices NormalizedVertices | None

Vertex-normalized planar output, if requested via normalize='vertices' or normalize='topology'.
normalized_topology NormalizedTopology | None

Edge-normalized planar topology, if requested via normalize='topology'.

The normalized structures intentionally carry their own augmented cell copies. They are not aliases of cells and may therefore still contain geometry that was omitted from the raw wrapper output.

global_edges property

Global planar edges if topology normalization is available.

global_vertices property

Global planar vertices from the available normalized output.

has_normalized_topology property

Whether topology normalization output is present.

has_normalized_vertices property

Whether vertex normalization output is present.

has_tessellation_diagnostics property

Whether tessellation diagnostics are present.

require_normalized_topology()

Return topology normalization output or raise a helpful error.

require_normalized_vertices()

Return vertex normalization output or raise a helpful error.

require_tessellation_diagnostics()

Return tessellation diagnostics or raise a helpful error.

:::