Struct WeightsToVtkBuilder

pub struct WeightsToVtkBuilder { /* private fields */ }

Builder implementation for WeightsToVtk configuration

The fields of WeightsToVtk are left public for direct use but the module also implements a builder.

For those not familiar, the builder allows for chained setter calls for a functional approach that could be considered more readable. Any number of parameters can be set this way (including none).

To get the final WeightsToVtk from the builder, call build().

// Make a new builder, change some values
let converter = WeightsToVtk::builder()
    .resolution(3)
    .compressor(Compressor::LZMA)
    .byte_order(ByteOrder::LittleEndian)
    .build();

// Convert the weight windows using the parameters set
let vtk = weights_to_vtk(&WeightWindow::default());

// Wite the VTK to a file in one of several formats
write_vtk(vtk, "output.vtk", VtkFormat::Xml).unwrap();

This helps separate the configuration from the actual conversion logic, and is often a style preference for many users.

Implementations

impl WeightsToVtkBuilder

pub fn new() -> Self

Create a new instance of the builder with default parameters

pub fn build(self) -> WeightsToVtk

Build the WeightsToVtk type

pub fn resolution(self, resolution: u8) -> Self

Cylindrical mesh resolution

Warning: Every vertex is defined explicitly, so large values will significantly increase memory usage and file size.

Integer value for increasing angular resolution of cylindrical meshes. Cylinders are approximated to straight edge segments so it can be useful to round this off by splitting voxels into multiple smaller segments.

e.g. 4 theta bins gives 4 edges and therefore looks square. Using --resolution 3 generates 12 edges instead and looks more rounded in plots.

pub fn byte_order(self, order: ByteOrder) -> Self

Set the byte ordering

Note that Visit being Visit only reads big endian, even though most systems are little endian. The byte order has one variant of the ByteOrder, defaulting to big endian for convenience.

pub fn compressor(self, xml_compressor: Compressor) -> Self

Set the compression method for xml file formats

Generally just use LZMA but other options are available:

• lzma (default)
• lz4
• zlib
• none

Trait Implementations

impl Default for WeightsToVtkBuilder

fn default() -> Self

Returns the “default value” for a type.