write_Field3d node

This node writes a Bifrost volume to a Field3D file.

Inputs

volume [in]

The Bifrost volume to write.

properties [in]

A space-delimited list of properties to write. Use * (asterisk) to specify all properties.

enable [in]

If true, enables writing. Otherwise, node acts as a pass-through.

filename [in]

The file name. Use # to include the input frame number. The number of occurences of # determines the amount of padding. For example, file####.3ed resolves to file0001.f3d, file0002.f3d, and so on.

directory [in]

The directory.

frame [in]

The frame number. You can connect the frame output of a time node to a to_long node, and then connect the result here.

overwrite [in]

If true, overwrites existing files.

create_directories [in]

If true, creates output directory hierarchy if it doesn't exist.

filter_property [in]

The voxel property used to decide which voxels to store.

threshold [in]

Voxels with a magnitude greater than threshold will be stored.

file_format [in]

The file format to use with Field3D. If in doubt, use Ogawa.

field_name [in]

If specified, overwrites the internal partition name stored in the Field3D file.

preview_name [in]

If specified, stores downsampled versions of all properties in a preview partition with the given name.

preview_level [in]

The resolution of the preview field is derived as the original resolution divided by two to the power of preview_level.

Outputs

out_volume [out]

Passthrough of the input volume.

success [out]

True, if file was written successfully.

file_path [out]

The full path of the written file.