Reference

FieldView

fieldview

Top-level Python entry point for FieldView automation.

The fieldview namespace exposes the main submodules used for in-process automation, including dataset access, formula creation, visualization object creation, layout and camera control, image export, shared constants, and common utility value types.

Use this top-level namespace when you want the overall package entry point, shared session helpers such as scene discovery, or convenient access to the major submodules through names like fieldview.data, fieldview.formula, and fieldview.vis.

Scene Discovery

fieldview.get_current_object()

Return the current scene object as its concrete wrapper type.

Returns None when FieldView has no current object.

Example usage:

>>> import fieldview as fv
>>> current = fv.get_current_object()
>>> if isinstance(current, fv.vis.Coord):
...     current.plane = fv.constant.Plane.Y
... elif isinstance(current, fv.vis.Iso):
...     current.visibility = False

Notes

Do not manually cast the result to another wrapper type. The returned object is already the correct runtime type. Use isinstance before accessing type-specific properties.

Return type:

object | None

fieldview.get_all_objects()

Return all scene objects grouped by public wrapper type.

Example usage:

>>> import fieldview as fv
>>> objects = fv.get_all_objects()
>>> for coord in objects.coord_list:
...     coord.visibility = True
>>> for text in objects.annotation_text_list:
...     print(text.text)

Return type:

ObjectLists

class fieldview.ObjectLists

Grouped scene objects returned by get_all_objects().

Example usage:

>>> import fieldview as fv
>>> objects = fv.get_all_objects()
>>> len(objects.coord_list)
1
>>> coord = objects.coord_list[0]
>>> coord.plane = fv.constant.Plane.Y

annotation_arrow_list: list[object]

annotation_text_list: list[object]

boundary_list: list[object]

comp_list: list[object]

coord_list: list[object]

iso_list: list[object]

particle_paths_list: list[object]

plot2d_list: list[object]

reattachment_lines_list: list[object]

separation_lines_list: list[object]

streamlines_list: list[object]

surface_flows_list: list[object]

vortex_cores_list: list[object]

Host Control

fieldview.exit(status=0)

Exit the FieldView host process.

This is the direct Python API for host shutdown.

Parameters:

status (int) – Process exit status to report back to test harnesses or other automation. Defaults to 0.

Return type:

None

Example:

import fieldview as fv

fv.exit()
# or
fv.exit(2)

fieldview.fv_script(script)

Execute SCR script text through the FieldView host.

Parameters:

script (str) – SCR command text to execute. The string must be non-empty after trimming whitespace.

Return type:

None

Example:

import fieldview as fv

fv.fv_script("OUTLINE ON")

Data

fieldview.data

Dataset loading, access, and query helpers for FieldView.

The fieldview.data namespace covers the full dataset lifecycle: loading supported file formats, selecting or discovering the current dataset, probing values, accessing registered scalar/vector/position arrays, working with transient data, and retrieving session or window metadata tied to the active scene.

Typical usage:

ds = fv.data.load_plot3d(“grid.g”, “sol.q”)

Loading Data

fieldview.data.load_plot3d(grid_file, q_file='', function_file='', function_name_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, merged_series=None, auto_detect_format=None, file_format=None, auto_partition=None, ghost_cells=None, iblanks=None, multi_grid=None, coords=None)

Load Plot3D data and return a Dataset.

Parameters:

• grid_file (str | PathLike[str]) – Plot3D grid file path.

• q_file (str | PathLike[str]) – Optional Plot3D solution/Q file path.

• function_file (str | PathLike[str]) – Optional Plot3D function file path.

• function_name_file (str | PathLike[str]) – Optional Plot3D function-name file path.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• merged_series (bool | None) – When True, treat matching Plot3D files as a merged time series.

• auto_detect_format (bool | None) – Optional Plot3D format detection or explicit format override.

• file_format (str | Plot3dFileFormat | None) – Optional Plot3D format detection or explicit format override.

• auto_partition (bool | None) – When True, enable reader-side auto partitioning.

• ghost_cells (int | None) – Number of ghost-cell layers to interpret.

• iblanks (bool | None) – When True, enable iblank handling.

• multi_grid (bool | None) – When True, treat the input as a multigrid dataset.

• coords (str | Plot3dCoords | None) – Optional Plot3D coordinate interpretation override.

Return type:

Dataset

Example usage:

>>> import fieldview as fv
>>> grid_file = "/path/to/grid.bin"
>>> q_file = "/path/to/q.bin"
>>> ds = fv.data.load_plot3d(grid_file, q_file)

fieldview.data.load_overflow2(grid_file, q_file='', function_file='', function_name_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, merged_series=None, auto_detect_format=None, file_format=None, auto_partition=None, ghost_cells=None, iblanks=None, multi_grid=None, coords=None)

Load Overflow-2 (Plot3D-compatible) data and return a Dataset.

Parameters:

• grid_file (str | PathLike[str]) – Plot3D-compatible grid file path.

• q_file (str | PathLike[str]) – Optional solution/Q file path.

• function_file (str | PathLike[str]) – Optional function file path.

• function_name_file (str | PathLike[str]) – Optional function-name file path.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• merged_series (bool | None) – When True, treat matching files as a merged time series.

• auto_detect_format (bool | None) – Optional format detection or explicit format override.

• file_format (str | Plot3dFileFormat | None) – Optional format detection or explicit format override.

• auto_partition (bool | None) – When True, enable reader-side auto partitioning.

• ghost_cells (int | None) – Number of ghost-cell layers to interpret.

• iblanks (bool | None) – When True, enable iblank handling.

• multi_grid (bool | None) – When True, treat the input as a multigrid dataset.

• coords (str | Plot3dCoords | None) – Optional coordinate interpretation override.

Return type:

Dataset

fieldview.data.load_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

Example usage:

>>> import fieldview as fv
>>> file = "/path/to/model.fvuns"
>>> results_file = "/path/to/results.fvuns"
>>> ds = fv.data.load_fvuns(file=file, results_file=results_file)

fieldview.data.load_vtk_structured(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load VTK structured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary VTK structured file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_acusolve_direct(file, results_file='', input_mode=None, server_config=None, grid_processing=None, boundary_only=None, extended_variables=None, duplicate_boundaries=None)

Load AcuSolve direct data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary AcuSolve input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

• extended_variables (bool | None) – When True, request extended-variable import.

• duplicate_boundaries (bool | None) – When True, preserve duplicate boundary information during import.

Return type:

Dataset

fieldview.data.load_acusolve_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load AcuSolve FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary AcuSolve FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_ansys_cfx_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load ANSYS-CFX FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary ANSYS-CFX FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_fluent_cff_direct(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load Fluent CFF direct data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary Fluent CFF input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_append_sampled_data(file)

Load Append Sampled Data and return a Dataset.

Parameters:

file (str | PathLike[str]) – Input file path for the sampled-data dataset.

Return type:

Dataset

fieldview.data.load_pw_common(file)

Load pw common data and return a Dataset.

Parameters:

file (str | PathLike[str]) – Input file path for the pw common dataset.

Return type:

Dataset

fieldview.data.load_cfdpp_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load CFD++ FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary CFD++ FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_cgns_structured(file, results_file='', input_mode=None, server_config=None, grid_processing=None)

Load CGNS structured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary CGNS structured file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_cgns_unstructured(file, results_file='', input_mode=None, server_config=None, grid_processing=None, boundary_only=None)

Load CGNS unstructured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary CGNS unstructured file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_cgns_unstructured_hybrid(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load CGNS unstructured hybrid data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary CGNS hybrid file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_cobalt_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load COBALT FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary COBALT FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_converge_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load CONVERGE FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary CONVERGE FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_ensight(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load Ensight data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary Ensight input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_flow3d_animation(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None)

Load FLOW-3D animation data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary FLOW-3D animation file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

Return type:

Dataset

fieldview.data.load_flow3d_restart(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None)

Load FLOW-3D restart data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary FLOW-3D restart file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

Return type:

Dataset

fieldview.data.load_fluent_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load FLUENT FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary FLUENT FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_fluent_unstructured(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load Fluent unstructured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary Fluent unstructured file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_fluent_cas_dat_direct(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None, boundary_only=None)

Load FLUENT cas/dat direct data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary FLUENT cas/dat input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_fluent_direct(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load Fluent direct data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary Fluent direct input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_havoc(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load HAVOC data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary HAVOC input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_lsdyna_d3plot(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None, boundary_only=None)

Load LS-DYNA d3plot data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary LS-DYNA d3plot file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_lsdyna_state(file, results_file='', input_mode=None, server_config=None, grid_processing=None, boundary_only=None)

Load LS-DYNA state data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary LS-DYNA state file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_nparc_wind(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load NPARC/WIND data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary NPARC/WIND input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_openfoam_direct(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None, boundary_only=None)

Load OpenFOAM direct data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary OpenFOAM direct input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_openfoam_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None, boundary_only=None)

Load OpenFOAM FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary OpenFOAM FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_sc_tetra(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load SC/Tetra data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary SC/Tetra input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_sc_flow(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load SCFLOW data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary SCFLOW input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_scryu(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load SCRYU data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary SCRYU input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_sc_stream(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load SCSTREAM data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary SCSTREAM input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_starccm_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load STAR-CCM+ FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary STAR-CCM+ FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_starcd_fvuns(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load STAR-CD FV-UNS data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary STAR-CD FV-UNS file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_stl(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None)

Load STL data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary STL input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

Return type:

Dataset

fieldview.data.load_surface_sampled_data(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load surface sampled data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary surface-sampled-data input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_tecplot_360(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load Tecplot 360 data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary Tecplot 360 input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_ultrafluidx_direct(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None, boundary_only=None)

Load ultraFluidX data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary ultraFluidX input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_vtk_unstructured_hybrid(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load VTK unstructured/hybrid data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary VTK unstructured or hybrid input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_wind_structured(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None)

Load WIND structured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary WIND structured input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

Return type:

Dataset

fieldview.data.load_wind_unstructured(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, boundary_only=None)

Load WIND unstructured data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary WIND unstructured input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• boundary_only (bool | None) – When True, load only boundary/surface data.

Return type:

Dataset

fieldview.data.load_xdb_import(file, results_file='', input_mode=None, server_config=None, transient=None, read_as_steady_state=None, changing_number_of_grids_over_time=None, grid_processing=None, initial_time_index=None, initial_time_step=None, initial_solution_time=None)

Load XDB import data and return a Dataset.

Parameters:

• file (str | PathLike[str]) – Primary XDB import input file path.

• results_file (str | PathLike[str]) – Optional companion results file.

• input_mode (str | InputMode | None) – Optional dataset load mode. Use constant.InputMode.REPLACE or constant.InputMode.APPEND.

• server_config (str | ServerConfig | None) – Optional server configuration. Use constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a named .srv configuration.

• transient (bool | None) – Optional transient-reader settings.

• read_as_steady_state (bool | None) – Optional transient-reader settings.

• changing_number_of_grids_over_time (bool | None) – Optional transient-reader settings.

• grid_processing (str | GridProcessing | None) – Optional grid-processing mode override.

• initial_time_index (int | None) – Optional initial transient selection after load.

• initial_time_step (int | None) – Optional initial transient selection after load.

• initial_solution_time (float | None) – Optional initial transient selection after load.

Return type:

Dataset

Data Access

class fieldview.data.Dataset

Base dataset wrapper.

A Dataset instance tracks a loaded dataset in FieldView. If a new load happens with input_mode=REPLACE, existing dataset objects are invalidated.

property boundary_types: list[str]

Return boundary type names loaded for this dataset.

copy()

Return an independent dataset copy loaded in append mode.

Return type:

Dataset

property cur_solution_time: float

Return the current transient solution time.

property cur_time_step: int

Return the current transient time step index.

property data_format: str

Return the dataset format label.

property dataset_id: int

Return the host dataset identifier.

dump()

Print dataset state to stdout.

Return type:

None

property duplication: DuplicationController

Access duplication controls (mirror/rotate/translate).

duplication_clear()

Clear duplication state for this dataset.

Return type:

None

property grid_file: str

Return the grid (or combined) file path.

property has_solution_times: bool

Return True if solution times are available.

property input_mode: str

Return the dataset input mode label.

property is_unstructured: bool

Return True when the host dataset is unstructured.

property num_grids: int

Return the number of grids in this dataset.

property positions: PositionRegistry

Return native XYZ position snapshots for this dataset.

property result_file: str

Return the results file path, if any.

property rmax: float

Return the maximum R bound.

property rmin: float

Return the minimum R bound.

property scalar_functions: list[str]

Return scalar function names loaded for this dataset (sorted).

The list is populated at load time and updated by APIs that add functions.

property scalars: ScalarRegistry

Return scalar-function registry access for this dataset.

property server: str

Get or set the current server name.

server_config(server_config)

Select a server configuration.

Parameters:

server_config (str | ServerConfig) – constant.ServerConfig.LOCAL, constant.ServerConfig.LOCAL_PARALLEL, or a configuration name string (without the .srv extension) under the sconfig folder.

Return type:

None

set_transient(*, time_step=None, solution_time=None)

Set the active transient time step or solution time.

Parameters:

• time_step (int | None) – Discrete transient time-step number to activate.

• solution_time (float | None) – Continuous solution-time value to activate.

Return type:

None

Example:

import os
import fieldview as fv

data_dir = os.path.join(fv.home, "examples", "rectangular_duct")
ds = fv.data.load_fvuns(os.path.join(data_dir, "rect_duct_010.uns"), transient=True)
ds.set_transient(time_step=25)

property solution_time_range: Range

Return the min/max transient solution-time range.

sweep_time(*, from_time_step=None, to_time_step=None, from_time_step_index=None, to_time_step_index=None, from_solution_time=None, to_solution_time=None, from_solution_time_index=None, to_solution_time_index=None, loop=False, skip=0, cycles=1, delta_time=None, streaklines_filename=None, extracts_database_name=None, export_surfaces=None)

Run a transient sweep for this dataset.

By default, this sweeps all available time steps from the first to the last step. delta_time=None restores the dataset’s original solution times (disables any active delta-time override). Index-based modes resolve endpoints through transient_info() before dispatching the sweep to the core. export_surfaces accepts tuple entries like (coord, "coord_sweep", "csv") or (coord, "coord_sweep").

Parameters:

• from_time_step (int | None) – Starting transient step value. Use together with to_time_step.

• to_time_step (int | None) – Ending transient step value. Use together with from_time_step.

• from_time_step_index (int | None) – Starting transient step index. 0 means the first step; negative values count from the end (-1 is the last step). Indices are resolved against TransientInfo.time_step_values.

• to_time_step_index (int | None) – Ending transient step index. -1 means the last step; negative values count from the end.

• from_solution_time (float | None) – Starting solution time value. Use together with to_solution_time.

• to_solution_time (float | None) – Ending solution time value. Use together with from_solution_time.

• from_solution_time_index (int | None) – Starting solution time index. Indices are resolved against TransientInfo.solution_time_values.

• to_solution_time_index (int | None) – Ending solution time index. Negative values count from the end.

• loop (bool) – Whether the host should loop the sweep continuously.

• skip (int) – Number of intermediate steps to skip between displayed or exported states.

• cycles (int) – Number of sweep cycles to run.

• delta_time (float | None) – Optional delta-time override for animated pathline or streakline calculations. If omitted, any prior override is cleared and original dataset solution times are used.

• streaklines_filename (str | PathLike[str] | None) – Optional output filename for streakline export generated during the sweep.

• extracts_database_name (str | PathLike[str] | None) – Optional extracts database name to write during the sweep.

• export_surfaces (object) – Optional iterable of surface export requests, each expressed as (surface, filename) or (surface, filename, format).

Return type:

None

Example:

import os
import fieldview as fv

data_dir = os.path.join(fv.home, "examples", "rectangular_duct")
ds = fv.data.load_fvuns(os.path.join(data_dir, "rect_duct_010.uns"), transient=True)
ds.sweep_time()
ds.sweep_time(from_time_step=1, to_time_step=10)
ds.sweep_time(from_time_step_index=-10, to_time_step_index=-1)  # last 10 frames
ds.sweep_time(from_solution_time=0.0, to_solution_time=0.3, cycles=1)
ds.sweep_time(from_solution_time_index=0, to_solution_time_index=-1)

property time_step_range: Range

Return the min/max transient time-step range.

property tmax: float

Return the maximum T bound.

property tmin: float

Return the minimum T bound.

property total_time_steps: int

Return the total number of transient time steps.

property transform: TransformController

Access transform controls (scale/translate/rotate).

property transient: bool

Return True if the dataset is transient.

transient_info()

Return transient dataset information.

Example:

import os
import fieldview as fv

data_dir = os.path.join(fv.home, "examples", "rectangular_duct")
ds = fv.data.load_fvuns(os.path.join(data_dir, "rect_duct_010.uns"), transient=True)
info = ds.transient_info()
print(info.time_step, info.total_time_steps)
print(info.time_step_values[:3])

Return type:

TransientInfo

property vector_functions: list[str]

Return vector function names loaded for this dataset (sorted).

The list is populated at load time and updated by APIs that add functions.

property vectors: VectorRegistry

Return vector-function registry access for this dataset.

property visibility: bool

Get or set dataset visibility state.

property xmax: float

Return the maximum X bound.

property xmin: float

Return the minimum X bound.

property ymax: float

Return the maximum Y bound.

property ymin: float

Return the minimum Y bound.

property zmax: float

Return the maximum Z bound.

property zmin: float

Return the minimum Z bound.

class fieldview.data.ScalarRegistry

Container-like access to dataset scalar functions.

create(name, values, *, grid=1)

Create or replace a named scalar function from array-like values.

Parameters:

• name (str)

• values (object)

• grid (int)

Return type:

ScalarArrayRef

snapshot(name, *, grid=1)

Return a read-only snapshot view for the named scalar function.

Parameters:

• name (str)

• grid (int)

Return type:

fieldview._core.DatasetArraySnapshotView

to_numpy(name, *, grid=1, copy=False)

Return the named scalar function as a NumPy array.

Parameters:

• name (str) – Scalar function name.

• grid (int) – 1-based grid number.

• copy (bool) – When False (default), return a read-only NumPy view over the snapshot buffer when possible. When True, return an independent writable NumPy copy.

Return type:

object

class fieldview.data.ScalarArrayRef

Reference to a named scalar function within a dataset.

property function_id: int

property name: str

snapshot(*, grid=1)

Return a read-only snapshot view for this scalar on grid.

If you convert the snapshot with numpy.asarray(), the resulting NumPy view keeps the snapshot backing alive even if the local snap variable is deleted.

Parameters:

grid (int)

Return type:

fieldview._core.DatasetArraySnapshotView

to_numpy(*, grid=1, copy=False)

Return this scalar snapshot as a NumPy array.

Parameters:

• grid (int) – 1-based grid number.

• copy (bool) – When False (default), return a read-only NumPy view over the snapshot buffer when possible. When True, return an independent writable NumPy copy.

Return type:

object

Notes

With copy=False, the returned NumPy array keeps the snapshot backing alive, so the array remains valid even if the local snap variable goes out of scope.

class fieldview.data.VectorRegistry

Container-like access to dataset vector functions.

create(name, values, *, grid=1)

Create or replace a named vector function from array-like values.

Parameters:

• name (str)

• values (object)

• grid (int)

Return type:

VectorArrayRef

snapshot(name, *, grid=1)

Return a read-only snapshot view for the named vector function.

Parameters:

• name (str)

• grid (int)

Return type:

fieldview._core.DatasetArraySnapshotView

to_numpy(name, *, grid=1, copy=False)

Return the named vector function as a NumPy array.

Parameters:

• name (str) – Vector function name.

• grid (int) – 1-based grid number.

• copy (bool) – When False (default), return a read-only NumPy view over the snapshot buffer when possible. When True, return an independent writable NumPy copy.

Return type:

object

class fieldview.data.VectorArrayRef

Reference to a named vector function within a dataset.

property function_id: int

property name: str

snapshot(*, grid=1)

Return a read-only snapshot view for this vector on grid.

If you convert the snapshot with numpy.asarray(), the resulting NumPy view keeps the snapshot backing alive even if the local snap variable is deleted.

Parameters:

grid (int)

Return type:

fieldview._core.DatasetArraySnapshotView

to_numpy(*, grid=1, copy=False)

Return this vector snapshot as a NumPy array.

Parameters:

• grid (int) – 1-based grid number.

• copy (bool) – When False (default), return a read-only NumPy view over the snapshot buffer when possible. When True, return an independent writable NumPy copy.

Return type:

object

Notes

With copy=False, the returned NumPy array keeps the snapshot backing alive, so the array remains valid even if the local snap variable goes out of scope.

class fieldview.data.PositionRegistry

Access to native XYZ node positions for dataset grids.

This registry is grid-oriented rather than function-oriented. Reads are snapshot-only and return (n, 3) XYZ data for the requested grid.

snapshot(*, grid=1)

Return a read-only snapshot view of native XYZ positions on grid.

If you convert the snapshot with numpy.asarray(), the resulting NumPy view keeps the snapshot backing alive even if the local snap variable is deleted.

Parameters:

grid (int)

Return type:

fieldview._core.DatasetArraySnapshotView

to_numpy(*, grid=1, copy=False)

Return native XYZ positions as a NumPy array.

Parameters:

• grid (int) – 1-based grid number.

• copy (bool) – When False (default), return a read-only NumPy view over the snapshot buffer when possible. When True, return an independent writable NumPy copy.

Returns:

A NumPy array with shape (n, 3) in native XYZ order.

Return type:

object

Notes

With copy=False, the returned NumPy array keeps the snapshot backing alive, so the array remains valid even if the local snap variable goes out of scope.

class fieldview.data.DatasetBounds

Axis-aligned bounding box for a dataset.

Cartesian axes are always populated. rmin/rmax and tmin/tmax are non-zero only for datasets with a cylindrical coordinate system.

rmax: float = 0.0

rmin: float = 0.0

tmax: float = 0.0

tmin: float = 0.0

xmax: float = 0.0

xmin: float = 0.0

ymax: float = 0.0

ymin: float = 0.0

zmax: float = 0.0

zmin: float = 0.0

class fieldview.data.WindowInfo

Metadata for a single graphics window.

background: str | None

background_image: str | None = None

current: bool

dataset_ids: list[int]

environment: str | None

environment_id: int | None = None

label: str | None

parent_window: int | None

scene_index: int

view_sync_enabled: bool

window: int

class fieldview.data.WindowList

Window enumeration payload returned by fieldview.layout.

current_window: int | None

windows: list[WindowInfo]

class fieldview.data.WindowSplitResult

Result metadata for a split-window operation.

mode: str

new_window: int

orientation: str

source_window: int

class fieldview.data.PerspectiveState

Perspective state for a graphics window.

angle: float

enabled: bool

class fieldview.data.CameraPose

Human-readable camera pose summary.

This describes the visible camera tuple in terms of eye, target, and up plus the current perspective mode. It is useful for inspection and approximate camera manipulation, but unlike ViewState it is not the authoritative deterministic replay format for FieldView views.

eye: tuple[float, float, float]

perspective_angle: float

perspective_enabled: bool

target: tuple[float, float, float]

up: tuple[float, float, float]

class fieldview.data.ViewState

Deterministic FieldView view state.

This is the exact replay representation for camera/view restore. It stores the same raw transform pieces that classic .vct restore uses along with the public perspective settings needed by the host command handler.

classmethod from_exact(exact_state, *, perspective_enabled, perspective_angle)

Create a deterministic view state from the exact transform payload.

Parameters:

• exact_state (CameraExactState)

• perspective_enabled (bool)

• perspective_angle (float)

Return type:

ViewState

perspective_angle: float

perspective_enabled: bool

perspective_z: float

rotation_angle: float

rotation_axis: tuple[float, float, float]

rotation_center: tuple[float, float, float] = (0.0, 0.0, 0.0)

rotation_center_on: bool = False

scale: float

to_exact_state()

Return the underlying exact transform payload.

Return type:

CameraExactState

translation: tuple[float, float, float]

zoom: float

fieldview.data.CameraState

alias of CameraPose

class fieldview.data.SessionState

Snapshot of the current FieldView session.

Returned by get_session_state(). Contains dataset metadata, domain bounds, function lists, and all existing surface objects in a single call.

When data_loaded is False, dataset_id is None and all lists are empty.

The returned fields are grouped roughly as follows:

• Dataset identity: data_loaded, dataset_id, data_format, reader_name, grid_file, result_file, num_grids

• Domain extents: bounds

• Transient state: transient, has_solution_times, cur_time_step, total_time_steps

• Available functions: scalar_functions, vector_functions

• Existing scene objects: objects

• Window/layout state: windows

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> state = fv.data.get_session_state()
>>> state.dataset_id, state.num_grids
>>> state.bounds.xmin, state.bounds.xmax
>>> len(state.scalar_functions), len(state.objects.boundary_list)

bounds: DatasetBounds

cur_time_step: int

data_format: str

data_loaded: bool

dataset_id: int | None

grid_file: str

has_solution_times: bool

num_grids: int

objects: object

reader_name: str

result_file: str

scalar_functions: list[str]

total_time_steps: int

transient: bool

vector_functions: list[str]

windows: WindowList | None = None

class fieldview.data.ProbeResult

Probe result for probed scalar/iso/threshold/vector functions.

hit reports whether the probe resolved to a dataset location. When hit is False, function names may still be populated while sampled values remain None. For IJK misses, point may also be None because no displayed-space location was resolved.

grid: int | None

grid_index: int | None

hit: bool

ijk: tuple[float, float, float] | None

iso: ScalarProbe

point: Vec3 | None

region: int | None

scalar: ScalarProbe

threshold: ScalarProbe

vector: VectorProbe

class fieldview.data.TransientInfo

Transient dataset state.

Instances are returned by Dataset.transient_info().

Example:

import os
import fieldview as fv

uns_file = os.path.join(fv.home, "examples", "rectangular_duct", "rect_duct_010.uns")
ds = fv.data.load_fvuns(uns_file, transient=True)
info = ds.transient_info()
print(info.time_step_values[:3])

has_solution_times: bool

solution_time: float

solution_time_range: Range

solution_time_values: tuple[float, ...]

time_step: int

time_step_range: Range

time_step_values: tuple[int, ...]

total_time_steps: int

class fieldview.data.IntegrationResult

Surface integration result.

Instances are returned by surface.integrate() and the coord/iso integrate_partial_surface() methods.

Common fields:

• integral_type identifies the host-side integration mode.

• scalar_function is the scalar function that was integrated.

• area is the surface integral ∫ f dA of the active scalar.

• sum is the total integral of the active scalar over the surface.

• average is the area-weighted mean, equal to sum / area when the host provides it.

When the target surface has normals and an active vector function, has_surface_normals is True and the normal/vector flux fields such as sum_nx and sum_v_dot_n may also be populated.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> surf = fv.vis.create_boundary(ds)
>>> surf.scalar_func = "Pressure [PLOT3D]"
>>> result = surf.integrate()
>>> result.area, result.sum, result.average

area: float

average: float | None

has_surface_normals: bool = False

integral_type: str

scalar_function: str | None

sum: float

sum_nx: float | None = None

sum_ny: float | None = None

sum_nz: float | None = None

sum_v_dot_n: float | None = None

surface: str | None = None

vector_function: str | None = None

Live Session

fieldview.data.get_current()

Return the current dataset from the live FieldView session.

If the dataset was loaded through the FieldView UI before Python attached to the session, this call reconstructs and caches a live Dataset wrapper on demand instead of failing on a Python-registry miss.

Replace-style reloads invalidate the previous wrapper for that dataset slot. Append-style reads allocate a new dataset id and leave existing wrappers valid.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> current = fv.data.get_current()
>>> current.dataset_id == ds.dataset_id

Return type:

Dataset

fieldview.data.get_session_state(include_functions=True)

Return a snapshot of the current FieldView session.

Retrieves dataset metadata, domain bounds, function lists, existing scene objects, and window/layout state in a single dispatcher round-trip. If no dataset is loaded, data_loaded is False and most fields are empty or None.

As a side effect, the current dataset is attached into the Python registry so that a subsequent get_current() call returns the cached wrapper at no extra cost.

This is the recommended first call for any automation script entering a live FieldView session with unknown state.

The returned SessionState is a compact snapshot with:

• dataset metadata and file names

• full domain bounds

• transient/time-step information

• scalar/vector function name lists

• all current graphics objects grouped in state.objects

• current window/layout information in state.windows

Append-vs-replace invalidation semantics:

• Replace-style reloads invalidate previously attached wrappers for the replaced dataset slot. Re-acquire wrappers after the reload completes.

• Append-style reads allocate a new dataset id and leave existing wrappers valid.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> state = fv.data.get_session_state()
>>> current = fv.data.get_current()   # cached after get_session_state()
>>> mid_x = (state.bounds.xmin + state.bounds.xmax) / 2.0
>>> len(state.scalar_functions), len(state.objects.boundary_list)

Parameters:

include_functions (bool) – When False, scalar/vector function lists are omitted from the response. Useful for large datasets where the script only needs object/bounds context.

Return type:

SessionState

Point Probes

fieldview.data.probe(point, dataset=None, *, scalar_func=None, vector_func=None, iso_func=None, threshold_func=None)

Probe selected functions at a displayed-space point.

Parameters:

• point (object) – Displayed-space XYZ probe location as a 3-number sequence.

• dataset (Dataset | None) – Target dataset. When omitted, the current dataset is used.

• scalar_func (object) – Optional scalar function name to make current before probing. When omitted, the existing current scalar is used.

• vector_func (object) – Optional vector function name to make current before probing. When omitted, the existing current vector is used.

• iso_func (object) – Optional iso/geometric function name to make current before probing. When omitted, the existing current iso/geometric function is used.

• threshold_func (object) – Optional threshold function name to make current before probing. When omitted, the existing current threshold function is used.

Returns:

ProbeResult with the probed location, resolved grid metadata, and sampled scalar/vector/iso/threshold values.

Return type:

ProbeResult

Notes

Any provided function override updates FieldView’s current function selection before probing and leaves that selection changed after the call returns. If an override is invalid or cannot be selected, the previous current-function state is preserved.

Example:

import os
import fieldview as fv

data_dir = os.path.join(fv.home, "examples", "f18")
ds = fv.data.load_plot3d(
    os.path.join(data_dir, "f18i9b_g_bin"),
    os.path.join(data_dir, "f18i9b_q_bin"),
)
result = fv.data.probe(
    (0.5, 0.5, 0.5),
    dataset=ds,
    scalar_func="Pressure",
    vector_func="Velocity",
)
print(result.scalar)
print(result.vector)

fieldview.data.probe_ijk(ijk_point, grid_index=None, *, grid=None, dataset=None, scalar_func=None, vector_func=None, iso_func=None, threshold_func=None)

Probe selected functions at a structured-grid IJK point.

Parameters:

• ijk_point (object) – Structured-grid IJK probe location as a 3-integer sequence.

• grid_index (int | None) – Optional 0-based actual-grid index.

• grid (int | None) – Optional 1-based grid number, matching the convention used by other public APIs. Provide either grid or grid_index. If both are provided, they must refer to the same grid.

• dataset (Dataset | None) – Target dataset. When omitted, the current dataset is used.

• scalar_func (object) – Optional scalar function name to make current before probing. When omitted, the existing current scalar is used.

• vector_func (object) – Optional vector function name to make current before probing. When omitted, the existing current vector is used.

• iso_func (object) – Optional iso/geometric function name to make current before probing. When omitted, the existing current iso/geometric function is used.

• threshold_func (object) – Optional threshold function name to make current before probing. When omitted, the existing current threshold function is used.

Returns:

ProbeResult with the resolved displayed-space point, grid metadata, and sampled scalar/vector/iso/threshold values.

Return type:

ProbeResult

Notes

Any provided function override updates FieldView’s current function selection before probing and leaves that selection changed after the call returns. If an override is invalid or cannot be selected, the previous current-function state is preserved.

Example:

import os
import fieldview as fv

data_dir = os.path.join(fv.home, "examples", "f18")
ds = fv.data.load_plot3d(
    os.path.join(data_dir, "f18i9b_g_bin"),
    os.path.join(data_dir, "f18i9b_q_bin"),
)

result = fv.data.probe_ijk((2, 3, 4), grid=1, dataset=ds, scalar_func="Pressure")
print(result.point)
print(result.scalar)

Formula

fieldview.formula

Formula creation and builder helpers for FieldView.

The fieldview.formula namespace exposes a thin wrapper over FieldView’s native formula system. Use it to define derived scalar or vector quantities from existing dataset functions, constants, and other formulas.

Formulas can be authored either as raw FieldView formula strings or through a lightweight Python builder:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds1 = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ds2 = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> qcrit = fv.formula.create(
...     "Qcrit",
...     'Qcriterion("Velocity Vectors [PLOT3D]")',
... )
>>> vel_mag = fv.formula.create(
...     "Velocity Magnitude",
...     fv.formula.mag("Velocity Vectors [PLOT3D]"),
... )
>>> delta_p = fv.formula.create(
...     "Delta Pressure",
...     fv.formula.dataset_quantity(2, "Pressure [PLOT3D]")
...     - fv.formula.dataset_quantity(1, "Pressure [PLOT3D]"),
... )

Builder expressions support normal arithmetic operators plus helper functions such as mag(), grad(), dot(), and qcriterion(). Bare strings are only accepted as top-level formula text passed to create() and as helper arguments such as mag("Velocity Vectors [PLOT3D]"); arithmetic builder expressions must use quantity() or dataset_quantity() explicitly.

Formula Creation

fieldview.formula.create(name, expr)

Create a named FieldView formula.

Parameters:

• name (str) – Unique formula name. The value must be non-empty and must not contain double quotes.

• expr (object) – Either a raw FieldView formula string or a builder expression composed from quantity(), dataset_quantity(), helper operations, numeric literals, and previously created Formula objects.

Returns:

Handle to the created host-side formula.

Return type:

Formula

Raises:

• InvalidArgumentError – If name or expr is invalid.

• CoreError – If the FieldView host rejects the formula.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> pressure_half = fv.formula.create(
...     "Pressure Half",
...     fv.formula.quantity("Pressure [PLOT3D]") / 2.0,
... )

class fieldview.formula.Formula

Reference to a created FieldView formula.

Instances are returned by create(). A Formula can be used inside later builder expressions, where it renders as a reference to the created formula name.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> vel_mag = fv.formula.create(
...     "Velocity Magnitude",
...     fv.formula.mag("Velocity Vectors [PLOT3D]"),
... )
>>> mach_like = fv.formula.create("Mach Like", vel_mag / 340.0)

delete()

Delete the formula through the host and invalidate this handle.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Temporary Pressure Half",
...     fv.formula.quantity("Pressure [PLOT3D]") / 2.0,
... )
>>> formula.delete()

Return type:

None

property name: str

Return the FieldView formula name.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Pressure Half",
...     fv.formula.quantity("Pressure [PLOT3D]") / 2.0,
... )
>>> formula.name
'Pressure Half'

render()

Return type:

str

Builder References

fieldview.formula.quantity(name)

Return a builder expression referencing a quantity or formula by name.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Pressure Half",
...     fv.formula.quantity("Pressure [PLOT3D]") / 2.0,
... )

Parameters:

name (str)

Return type:

_FormulaExpr

fieldview.formula.dataset_quantity(dataset, name)

Return a scene-relative dataset-comparison quantity reference.

Parameters:

• dataset (int) – 1-based dataset number in the current FieldView scene.

• name (str) – Quantity or formula name to read from that dataset.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds1 = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ds2 = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Delta Pressure",
...     fv.formula.dataset_quantity(2, "Pressure [PLOT3D]")
...     - fv.formula.dataset_quantity(1, "Pressure [PLOT3D]"),
... )

Builder Operations

fieldview.formula.mag(expr)

Return the magnitude of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to evaluate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Magnitude",
...     fv.formula.mag("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.grad(expr)

Return the gradient of a scalar expression.

Parameters:

expr (object) – Scalar quantity or expression to differentiate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Pressure Gradient",
...     fv.formula.grad("Pressure [PLOT3D]"),
... )

fieldview.formula.curl(expr)

Return the curl of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to differentiate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Curl",
...     fv.formula.curl("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.nrmlz(expr)

Return the normalized form of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to normalize.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Direction",
...     fv.formula.nrmlz("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.exp(expr)

Return EXP(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Exp Pressure",
...     fv.formula.exp(fv.formula.quantity("Pressure [PLOT3D]") / 1000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.ln(expr)

Return the natural logarithm of a scalar expression.

Parameters:

expr (object) – Scalar quantity or expression to transform.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Ln Pressure",
...     fv.formula.ln(fv.formula.quantity("Pressure [PLOT3D]") + 1.0),
... )

fieldview.formula.log(expr)

Return the base-10 logarithm of a scalar expression.

Parameters:

expr (object) – Scalar quantity or expression to transform.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Log Pressure",
...     fv.formula.log(fv.formula.quantity("Pressure [PLOT3D]") + 1.0),
... )

fieldview.formula.sin(expr)

Return SIN(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Sin Pressure",
...     fv.formula.sin(fv.formula.quantity("Pressure [PLOT3D]") / 1000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.cos(expr)

Return COS(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Cos Pressure",
...     fv.formula.cos(fv.formula.quantity("Pressure [PLOT3D]") / 1000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.tan(expr)

Return TAN(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Tan Pressure",
...     fv.formula.tan(fv.formula.quantity("Pressure [PLOT3D]") / 1000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.asin(expr)

Return ASIN(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Asin Half Pressure",
...     fv.formula.asin(fv.formula.quantity("Pressure [PLOT3D]") / 200000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.acos(expr)

Return ACOS(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Acos Half Pressure",
...     fv.formula.acos(fv.formula.quantity("Pressure [PLOT3D]") / 200000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.atan(expr)

Return ATAN(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Atan Pressure",
...     fv.formula.atan(fv.formula.quantity("Pressure [PLOT3D]") / 1000.0),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.atan2(lhs, rhs)

Return ATAN2(lhs, rhs).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Pressure Angle",
...     fv.formula.atan2(
...         fv.formula.quantity("Pressure [PLOT3D]"),
...         fv.formula.quantity("Pressure [PLOT3D]") + 1.0,
...     ),
... )

Parameters:

• lhs (object)

• rhs (object)

Return type:

_FormulaExpr

fieldview.formula.sqrt(expr)

Return SQRT(expr).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Sqrt Pressure",
...     fv.formula.sqrt(fv.formula.quantity("Pressure [PLOT3D]")),
... )

Parameters:

expr (object)

Return type:

_FormulaExpr

fieldview.formula.abs(expr)

Return the absolute value of a scalar expression.

Parameters:

expr (object) – Scalar quantity or expression to transform.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Absolute Pressure Offset",
...     fv.formula.abs(fv.formula.quantity("Pressure [PLOT3D]") - 100000.0),
... )

fieldview.formula.div(expr)

Return the divergence of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to differentiate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Divergence",
...     fv.formula.div("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.vecx(expr)

Return the X component of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to read from.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity X",
...     fv.formula.vecx("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.vecy(expr)

Return the Y component of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to read from.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Y",
...     fv.formula.vecy("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.vecz(expr)

Return the Z component of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to read from.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Z",
...     fv.formula.vecz("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.dot(lhs, rhs)

Return the FieldView infix DOT operation between two vectors.

Parameters:

• lhs (object) – Left-hand vector quantity or expression.

• rhs (object) – Right-hand vector quantity or expression.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity X Projection",
...     fv.formula.dot("Velocity Vectors [PLOT3D]", fv.formula.unit_x),
... )

fieldview.formula.cross(lhs, rhs)

Return the FieldView infix CROSS operation between two vectors.

Parameters:

• lhs (object) – Left-hand vector quantity or expression.

• rhs (object) – Right-hand vector quantity or expression.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Velocity Cross Unit X",
...     fv.formula.cross("Velocity Vectors [PLOT3D]", fv.formula.unit_x),
... )

fieldview.formula.qcriterion(expr)

Return the Q-criterion of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to evaluate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Q Criterion",
...     fv.formula.qcriterion("Velocity Vectors [PLOT3D]"),
... )

fieldview.formula.lambda2criterion(expr)

Return the Lambda2 criterion of a vector expression.

Parameters:

expr (object) – Vector quantity or expression to evaluate.

Return type:

_FormulaExpr

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> formula = fv.formula.create(
...     "Lambda2 Criterion",
...     fv.formula.lambda2criterion("Velocity Vectors [PLOT3D]"),
... )

Constants

fieldview.formula.pi

Formula constant for PI with value 3.141592653589793.

fieldview.formula.e

Euler’s number with value 2.718281828459045, rendered as a numeric literal for host compatibility.

fieldview.formula.unit_x

Formula vector constant for UNITX with value (1, 0, 0).

fieldview.formula.unit_y

Formula vector constant for UNITY with value (0, 1, 0).

fieldview.formula.unit_z

Formula vector constant for UNITZ with value (0, 0, 1).

fieldview.formula.alpha

Dataset-dependent formula constant for ALPHA.

fieldview.formula.fsmach

Dataset-dependent formula constant for FSMACH.

fieldview.formula.re

Dataset-dependent formula constant for RE.

fieldview.formula.time

Dataset-dependent formula constant for TIME.

fieldview.formula.gamma

Dataset-dependent formula constant for GAMMA.

fieldview.formula.r

Dataset-dependent formula constant for R.

Visualization

fieldview.vis

Visualization object creation and surface wrappers for FieldView.

The fieldview.vis namespace is the main entry point for creating and managing scene objects such as coordinate surfaces, computational surfaces, iso surfaces, boundary surfaces, streamlines, particle paths, vortex cores, and annotation objects.

The create_* functions construct new host-side objects and return the corresponding Python wrappers. Those wrappers expose high-level properties for appearance, function selection, geometry, clipping, integration, and object-specific operations without requiring direct dispatcher calls.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)

Object Creation Functions

vis.create_coord

fieldview.vis.create_coord(dataset=None, *, plane=None, x_plane=None, y_plane=None, z_plane=None, r_plane=None, t_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, ruled_grid=None, scalar_minmax=None, colormap=None, legend=None, sweep_steps=None)

Create a coordinate surface for the given dataset.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new coord surface to. When omitted, the current dataset is used.

• plane (Plane | str | None) – Active plane selection.

• x_plane (RangedValue | None) – Optional X-plane ranged-value controller.

• y_plane (RangedValue | None) – Optional Y-plane ranged-value controller.

• z_plane (RangedValue | None) – Optional Z-plane ranged-value controller.

• r_plane (RangedValue | None) – Optional R-plane ranged-value controller.

• t_plane (RangedValue | None) – Optional T-plane ranged-value controller.

• coloring (Coloring | str | None) – Coloring mode for the coord surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the new coord surface is initially visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• ruled_grid (RuledGridOptions | None) – Ruled-grid display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• sweep_steps (int | None) – Sweep step count.

Return type:

Coord

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> x_plane = fv.RangedValue(range=fv.Range(min=1.0, max=50.0), value=10.0)
>>> cs = fv.vis.create_coord(ds, plane=fv.constant.Plane.X, x_plane=x_plane)

vis.create_comp

fieldview.vis.create_comp(dataset=None, *, grid=None, grid_index=None, plane=None, i_plane=None, j_plane=None, k_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, I_inc=None, J_inc=None, K_inc=None)

Create a computational surface for the given dataset.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new comp surface to. When omitted, the current dataset is used.

• grid (int | None) – Optional 1-based dataset grid number.

• grid_index (int | None) – Optional 0-based dataset grid index.

• plane (Plane | str | None) – Active plane selection.

• i_plane (RangedValue | None) – Optional I-plane ranged-value controller.

• j_plane (RangedValue | None) – Optional J-plane ranged-value controller.

• k_plane (RangedValue | None) – Optional K-plane ranged-value controller.

• coloring (Coloring | str | None) – Coloring mode for the comp surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the new comp surface is initially visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• I_inc (int | None) – Sweep increment for the I axis.

• J_inc (int | None) – Sweep increment for the J axis.

• K_inc (int | None) – Sweep increment for the K axis.

Return type:

Comp

grid and grid_index are interchangeable aliases for selecting the target dataset grid. grid is 1-based to match the UI, while grid_index is 0-based for Python-style indexing. When both are provided, they must refer to the same grid. If neither is provided, the comp surface is created on grid 1.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> k_plane = fv.RangedValue(range=fv.Range(min=1, max=30), value=10)
>>> cs = fv.vis.create_comp(ds, grid_index=0, plane=fv.constant.Plane.K, k_plane=k_plane)

vis.create_iso

fieldview.vis.create_iso(dataset=None, *, iso_func, iso_value=None, cutting_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, unrolled=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, sweep_steps=None)

Create an iso surface for the given dataset.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new iso surface to. When omitted, the current dataset is used.

• iso_func (str | CuttingPlane | dict[str, object]) – Iso function name, cutting plane, or cutting-plane payload dict.

• iso_value (RangedValue | None) – Optional iso-value ranged-value controller.

• cutting_plane (CuttingPlane | dict[str, object] | None) – Optional cutting-plane override.

• coloring (Coloring | str | None) – Coloring mode for the iso surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• unrolled (bool | None) – Whether unrolled display is enabled.

• visibility (bool | None) – Whether the new iso surface is initially visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• sweep_steps (int | None) – Sweep step count.

Return type:

Iso

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso_value = fv.RangedValue(value=0.8)
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)", iso_value=iso_value)

vis.create_boundary

fieldview.vis.create_boundary(dataset=None, *, x_clip=None, y_clip=None, z_clip=None, r_clip=None, t_clip=None, coloring=None, material=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, types=None)

Create a boundary surface for a dataset.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new boundary surface to. When omitted, the current dataset is used.

• x_clip (Range | dict[str, object] | None) – Optional X clipping range.

• y_clip (Range | dict[str, object] | None) – Optional Y clipping range.

• z_clip (Range | dict[str, object] | None) – Optional Z clipping range.

• r_clip (Range | dict[str, object] | None) – Optional R clipping range.

• t_clip (Range | dict[str, object] | None) – Optional T clipping range.

• coloring (Coloring | str | None) – Coloring mode for the boundary surface.

• material (Material | str | None) – Material selection used when material coloring is active.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the new boundary surface is initially visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• types (BoundaryTypeSelection | str | list[str] | tuple[str, ...] | None) – Boundary-type selection or explicit boundary-type names.

Return type:

Boundary

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.coloring = fv.constant.Coloring.SCALAR
>>> bnd.scalar_func = ds.scalar_functions[0]
>>> bnd.colormap.name = fv.constant.ColormapName.SPECTRUM

vis.create_surface_flows

fieldview.vis.create_surface_flows(dataset=None, *, mode, visibility=None, line_type=None, geometric_color=None, coloring=None, scalar_func=None, scalar_path_variable=None, vector_func=None, direction=None, time_limit_enabled=None, time_limit=<object object>, seeding=None, seed_file=<object object>, offset_distance=None, step=None, colormap=None, legend=None, calculate=False)

Create a surface restricted flow path object.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new feature object to. When omitted, the current dataset is used.

• mode (SurfaceFlowMode | str) – Surface-flow extraction mode.

• visibility (bool | None) – Whether the object is initially visible.

• line_type (LineType | str | None) – Line style used for the extracted paths.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted paths.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• scalar_path_variable (str | None) – Path-variable name used for scalar coloring.

• vector_func (str | None) – Vector function name used for path calculation.

• direction (CalculationDirection | str | None) – Integration direction.

• time_limit_enabled (bool | None) – Whether the time-limit field is enabled.

• time_limit (float | None | object) – Optional tracing time limit.

• seeding (SurfaceFlowSeeding | str | None) – Seeding mode.

• seed_file (str | PathLike[str] | None | object) – Optional seed-file path.

• offset_distance (float | None) – Surface offset distance.

• step (int | None) – Integration step count.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

• calculate (bool) – When True, run the calculation after creation.

Return type:

SurfaceFlows

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sf = fv.vis.create_surface_flows(
...     ds,
...     mode=fv.constant.SurfaceFlowMode.NO_SLIP,
...     vector_func="Velocity Vectors [PLOT3D]",
...     direction=fv.constant.CalculationDirection.BOTH,
... )
>>> sf.calculate()

vis.create_separation_lines

fieldview.vis.create_separation_lines(dataset=None, *, visibility=None, line_type=None, geometric_color=None, coloring=None, colormap=None, legend=None)

Create a separation-line feature-extraction object.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new feature object to. When omitted, the current dataset is used.

• visibility (bool | None) – Whether the object is initially visible.

• line_type (LineType | str | None) – Line style used for the extracted lines.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted lines.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

SeparationLines

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sep = fv.vis.create_separation_lines(
...     ds,
...     coloring=fv.constant.Coloring.SCALAR,
... )

vis.create_reattachment_lines

fieldview.vis.create_reattachment_lines(dataset=None, *, visibility=None, line_type=None, geometric_color=None, coloring=None, colormap=None, legend=None)

Create a reattachment-line feature-extraction object.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new feature object to. When omitted, the current dataset is used.

• visibility (bool | None) – Whether the object is initially visible.

• line_type (LineType | str | None) – Line style used for the extracted lines.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted lines.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

ReattachmentLines

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> reatt = fv.vis.create_reattachment_lines(
...     ds,
...     line_type=fv.constant.LineType.THICK,
... )

vis.create_streamlines

fieldview.vis.create_streamlines(dataset=None, *, coloring=None, geometric_color=None, line_type=None, display_type=None, sphere_scale=None, ribbon_width=None, transparency=None, visibility=None, scalar_func=None, vector_func=None, animate=None, animate_direction=None, animate_divs=None, show_seeds=None, seed_coord=None, direction=None, step=None, time_limit=<object object>, release_interval=None, duration=None, colormap=None, legend=None, defer_apply=False, calculate=False)

Create a streamlines surface for the given dataset.

vector_func is required and can be any dataset vector function name. When provided, release_interval and duration must satisfy release_interval > 0 and 0 < duration < release_interval.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new streamlines surface to. When omitted, the current dataset is used.

• coloring (Coloring | str | None) – Coloring mode for the streamline geometry.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• line_type (LineType | str | None) – Streamline line style.

• display_type (PathsDisplayType | str | None) – Path display type such as complete, filament, or ribbon.

• sphere_scale (float | None) – Sphere or arrow size scale.

• ribbon_width (int | None) – Ribbon width used by ribbon display modes.

• transparency (float | None) – Transparency amount for the streamline geometry.

• visibility (bool | None) – Whether the new streamline object is initially visible.

• scalar_func (str | None) – Optional scalar function name used for scalar coloring.

• vector_func (str | None) – Required vector function name used for streamline integration.

• animate (bool | None) – Whether streamline animation is enabled.

• animate_direction (AnimationDirection | str | None) – Direction used for streamline animation.

• animate_divs (int | None) – Number of animation divisions.

• show_seeds (bool | None) – Whether seed markers are shown.

• seed_coord (StreamlinesSeedCoord | str | None) – Seed coordinate system to use for subsequent seed operations.

• direction (CalculationDirection | str | None) – Integration direction used for calculation.

• step (int | None) – Integration step size.

• time_limit (float | None | object) – Optional tracing time limit. Pass None to clear the current limit.

• release_interval (int | None) – Optional streakline release interval.

• duration (int | None) – Optional streakline duration.

• colormap (Colormap | dict[str, object] | None) – Optional colormap settings as a Colormap or payload dict.

• legend (Legend | dict[str, object] | None) – Optional legend settings as a Legend or payload dict.

• defer_apply (bool) – When True, create the object without forcing an immediate apply/calculation step.

• calculate (bool) – When True, run streamline calculation after creation.

Return type:

Streamlines

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(
...     ds,
...     vector_func=ds.vector_functions[0],
...     coloring=fv.constant.Coloring.SCALAR,
...     scalar_func=ds.scalar_functions[0],
...     seed_coord=fv.constant.StreamlinesSeedCoord.IJK_REAL,
... )
>>> sl.add_seeds([(1.0, 1.0, 1.0), (40.0, 20.0, 10.0)], grid=1)
>>> sl.calculate()

vis.create_particle_paths

fieldview.vis.create_particle_paths(dataset=None, *, filename, format='fv particle path', coloring=None, geometric_color=None, line_type=None, display_type=None, sphere_scale=None, transparency=None, visibility=None, scalar_func=None, animate=None, animate_direction=None, animate_divs=None, subset_inc=None, select_by_initial_value=None, select_by_initial_value_variable=None, select_by_initial_value_min=None, select_by_initial_value_max=None, select_by_value_on_path=None, select_by_value_on_path_variable=None, select_by_value_on_path_min=None, select_by_value_on_path_max=None, select_by_tags=None, tags=None, colormap=None, legend=None, defer_apply=False)

Import and create a particle-paths surface.

filename is required and must point to an existing particle-path file supported by the selected format. Only one particle-paths object is supported per dataset. Delete the existing particle paths before creating a new one on the same dataset. A second create on the same dataset raises InvalidArgumentError.

Parameters:

• dataset (Dataset | None) – Dataset to attach the new particle-paths object to. When omitted, the current dataset is used.

• filename (str | PathLike[str]) – Particle-path file to import.

• format (str) – Particle-path file format name.

• coloring (Coloring | str | None) – Coloring mode for the particle paths.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• line_type (LineType | str | None) – Line style used for the particle paths.

• display_type (PathsDisplayType | str | None) – Path display type such as complete or filament.

• sphere_scale (float | None) – Sphere or marker size scale.

• transparency (float | None) – Particle-path transparency amount.

• visibility (bool | None) – Whether the imported particle paths are initially visible.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• animate (bool | None) – Whether particle-path animation is enabled.

• animate_direction (AnimationDirection | str | None) – Direction used for animation.

• animate_divs (int | None) – Number of animation divisions.

• subset_inc (int | None) – Subsampling increment for displayed paths.

• select_by_initial_value (bool | None) – Whether initial-value filtering is enabled.

• select_by_initial_value_variable (str | None) – Variable name used for initial-value filtering.

• select_by_initial_value_min (float | None) – Initial-value filter minimum.

• select_by_initial_value_max (float | None) – Initial-value filter maximum.

• select_by_value_on_path (bool | None) – Whether value-on-path filtering is enabled.

• select_by_value_on_path_variable (str | None) – Variable name used for value-on-path filtering.

• select_by_value_on_path_min (float | None) – Value-on-path filter minimum.

• select_by_value_on_path_max (float | None) – Value-on-path filter maximum.

• select_by_tags (bool | None) – Whether tag-based filtering is enabled.

• tags (str | Sequence[str] | None) – Tag names to select when tag-based filtering is used.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

• defer_apply (bool) – When True, defer the final apply step after creation.

Return type:

ParticlePaths

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(
...     ds,
...     filename="/path/to/particle_paths.fvp",
...     coloring=fv.constant.Coloring.SCALAR,
...     scalar_func="Duration",
... )

vis.create_plot2d

fieldview.vis.create_plot2d(dataset=None, *, left_axis_func=None, right_axis_func=None, show_right_axis=None, show_path=None, show_plot=None, background=None, horizontal_axis_mode=None, path_style=None, sampling=None, annotation=None, options=None)

Create a 2D plot for the current or supplied dataset.

Parameters

dataset:

Dataset to attach to the new plot. When omitted, the current dataset is used.

left_axis_func:

Scalar function name for the left axis. When omitted, FieldView keeps its default left-axis function.

right_axis_func:

Scalar function name for the right axis. Use None to leave the right axis disabled.

show_right_axis, show_path, show_plot, background:

Initial display flags for the new plot.

horizontal_axis_mode:

Horizontal axis quantity such as distance, x, y, or z.

path_style:

Plot style for rendered path data.

sampling, annotation, options:

Nested dictionaries or typed payload objects from fieldview.utils matching the corresponding helper objects on Plot2D.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> left_func = ds.scalar_functions[0]
>>> plot = fv.vis.create_plot2d(
...     ds,
...     left_axis_func=left_func,
...     show_plot=True,
...     show_path=True,
... )

Parameters:

• dataset (Dataset | None)

• left_axis_func (str | None)

• right_axis_func (str | None)

• show_right_axis (bool | None)

• show_path (bool | None)

• show_plot (bool | None)

• background (bool | None)

• horizontal_axis_mode (Plot2DHorizontalAxis | str | None)

• path_style (Plot2DPathStyle | str | None)

• sampling (Plot2DSamplingOptions | Mapping[str, object] | None)

• annotation (Plot2DAnnotationOptions | Mapping[str, object] | None)

• options (Plot2DOptions | Mapping[str, object] | None)

Return type:

Plot2D

vis.create_vortex_cores

fieldview.vis.create_vortex_cores(dataset=None, *, method, vector_func, visibility=None, line_type=None, geometric_color=None, min_vortex_strength_enabled=None, min_vortex_strength=None, coloring=None, scalar_func=None, scalar_path_variable=None, colormap=None, legend=None)

Create a vortex-cores surface.

method and vector_func are required. method must be "Vorticity Alignment" or "Eigenmode Analysis".

Parameters:

• dataset (Dataset | None) – Dataset to attach the new feature object to. When omitted, the current dataset is used.

• method (VortexCoreMethod | str) – Vortex-core extraction method.

• vector_func (str) – Vector variable name used for the extraction.

• visibility (bool | None) – Whether the object is initially visible.

• line_type (LineType | str | None) – Line style used for the extracted cores.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• min_vortex_strength_enabled (bool | None) – Whether the minimum-vortex-strength filter is enabled.

• min_vortex_strength (float | None) – Minimum vortex-strength filter value.

• coloring (Coloring | str | None) – Coloring mode for the extracted cores.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• scalar_path_variable (str | None) – Path-variable name used for scalar coloring.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

VortexCores

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> vc = fv.vis.create_vortex_cores(
...     ds,
...     method="Vorticity Alignment",
...     vector_func="Vorticity Vectors [PLOT3D]",
...     coloring=fv.constant.Coloring.SCALAR,
...     scalar_path_variable="Vortex Strength",
... )

vis.create_annotation_text

fieldview.vis.create_annotation_text(text, *, position=None, visibility=None, color=None, font=None, font_size=None, align=None, direction=None)

Create a screen-space text annotation.

Parameters:

• text (str)

• position (object)

• visibility (bool | None)

• color (GeometricColor | int | None)

• font (Font | str | None)

• font_size (int | None)

• align (AnnotationTextAlign | str | None)

• direction (AnnotationTextDirection | str | None)

Return type:

AnnotationText

vis.create_annotation_arrow

fieldview.vis.create_annotation_arrow(tip, tail, *, visibility=None, color=None)

Create a screen-space arrow annotation.

Parameters:

• tip (object)

• tail (object)

• visibility (bool | None)

• color (GeometricColor | int | None)

Return type:

AnnotationArrow

Coordinate Surface Class

class fieldview.vis.Coord

Coordinate surface wrapper.

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>>
>>> cs = fv.vis.create_coord(ds)
>>> cs.plane = fv.constant.Plane.X
>>> cs.x_plane.value = 2.0
>>> cs.coloring = fv.constant.Coloring.SCALAR
>>> cs.transparency = 0.5
>>> cs.colormap.name = fv.constant.ColormapName.SPECTRUM

property coloring: Coloring

Coloring mode (geometric, scalar, or material).

Type:

Coloring

property colormap: Colormap

Scalar colormap options.

Type:

Colormap

property contours: ContourColoring

Contour color mode.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.contours = fv.constant.ContourColoring.BLACK

Type:

ContourColoring

copy()

Return a new coord surface with the same settings.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> copy_obj = cs.copy()

Return type:

Coord

delete()

Delete this coord surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.delete()

Return type:

None

property display_type: DisplayType

Surface display type.

Type:

DisplayType

export(filename, format='txt')

Export this coordinate surface to a text/MAT/CSV file.

Parameters:

• filename (str | PathLike[str]) – Destination export path.

• format (str) – Export format string. Supported values are txt, mat, and csv.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.export("/tmp/coord_surface.csv", format="csv")

property geometric_color: GeometricColor

Geometric color used when not scalar-colored.

Type:

GeometricColor

integrate()

Integrate the current scalar function over this surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> surf = fv.vis.create_boundary(ds)
>>> surf.scalar_func = ds.scalar_functions[0]
>>> result = surf.integrate()
>>> result.surface
'boundary_surf'

Return type:

object

integrate_partial_surface(point, tolerance=None)

Integrate the connected partial region containing point.

Returns None when point does not isolate a partial region on the current coordinate surface.

Parameters:

• point (object) – XYZ point used to identify the connected partial region.

• tolerance (float | None) – Optional coordinate tolerance used while locating the partial region.

Return type:

IntegrationResult | None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> probe = fv.data.probe_ijk((2, 3, 4), grid=1, dataset=ds)
>>> cs = fv.vis.create_coord(ds)
>>> cs.scalar_func = probe.scalar.func
>>> cs.plane = fv.constant.Plane.X
>>> cs.x_plane.value = probe.point.x
>>> result = cs.integrate_partial_surface(tuple(probe.point))

property legend: Legend

Legend options for scalar coloring.

Type:

Legend

property line_type: LineType

Line type used to render the graphic.

Type:

LineType

modify(*, plane=None, x_plane=None, y_plane=None, z_plane=None, r_plane=None, t_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, ruled_grid=None, scalar_minmax=None, colormap=None, legend=None, sweep_steps=None)

Modify multiple coord properties atomically.

Parameters:

• plane (Plane | str | None) – Active plane selection.

• x_plane (RangedValue | None) – Optional X-plane ranged-value controller.

• y_plane (RangedValue | None) – Optional Y-plane ranged-value controller.

• z_plane (RangedValue | None) – Optional Z-plane ranged-value controller.

• r_plane (RangedValue | None) – Optional R-plane ranged-value controller.

• t_plane (RangedValue | None) – Optional T-plane ranged-value controller.

• coloring (Coloring | str | None) – Coloring mode for the coord surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the coord surface is visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• ruled_grid (RuledGridOptions | None) – Ruled-grid display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• sweep_steps (int | None) – Sweep step count.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.modify(coloring=fv.constant.Coloring.SCALAR, transparency=0.5)

property phigs_obj: int

Public PHIGS object identifier for this graphic.

Type:

int

property plane: Plane

Active plane (x/y/z/r/t).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.plane = fv.constant.Plane.Y

Type:

Plane

property r_plane: RangedValue

R plane range controller (cylindrical datasets).

Example usage:

>>> import os
>>> import fieldview as fv
>>> dataset_path = os.path.join(
...     fv.home, "examples", "heat_exchanger", "cocurrent.uns"
... )
>>> ds = fv.data.load_fvuns(dataset_path)
>>> cs = fv.vis.create_coord(ds, plane=fv.constant.Plane.R)
>>> cs.r_plane.value = 1.0

Type:

RangedValue

property ruled_grid: RuledGridOptions

Ruled grid options.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.ruled_grid.show = True
>>> cs.ruled_grid.color = fv.constant.GeometricColor.RED

Type:

RuledGridOptions

property scalar_func: str | None

Selected scalar function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.scalar_func = "Density (Q1)"

Type:

str | None

property scalar_minmax: ScalarMinMax

Scalar min/max options.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.scalar_minmax.show = True
>>> cs.scalar_minmax.max.text = "Max: %%SCALAR_MAX"

Type:

ScalarMinMax

property show_mesh: bool

Mesh overlay visibility.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.show_mesh = True

Type:

bool

sweep(cycles=1, output_file=None, direction=None)

Sweep the coordinate surface and optionally write frames to a file.

Parameters:

• cycles (int) – Number of sweep cycles to run.

• output_file (str | PathLike[str] | None) – Optional movie or frame output path.

• direction (SweepDirection | None) – Optional sweep direction mode.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.sweep(2, "/tmp/out.mp4", fv.constant.SweepDirection.BOUNCE)

property sweep_steps: int

Sweep step count.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.sweep_steps = 50

Type:

int

property t_plane: RangedValue

T plane range controller (cylindrical datasets).

Example usage:

>>> import os
>>> import fieldview as fv
>>> dataset_path = os.path.join(
...     fv.home, "examples", "heat_exchanger", "cocurrent.uns"
... )
>>> ds = fv.data.load_fvuns(dataset_path)
>>> cs = fv.vis.create_coord(ds, plane=fv.constant.Plane.T)
>>> cs.t_plane.value = 15.0

Type:

RangedValue

property threshold: bool

Threshold enabled state.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.threshold = True

Type:

bool

property threshold_func: str | None

Selected threshold function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.threshold_func = "Density (Q1)"

Type:

str | None

property threshold_range: Range

Threshold range.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.threshold_range = fv.Range(0.5, 1.0)

Type:

Range

property transparency: float

Surface transparency (0.0-1.0).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.transparency = 0.5

Type:

float

property vector_func: str | None

Selected vector function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.vector_func = "Momentum Vectors [PLOT3D]"

Type:

str | None

property vector_options: VectorOptions

Vector display options.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.vector_options.head_type = fv.constant.VectorHeadType.HEAD3D
>>> cs.vector_options.shaft_type = fv.constant.VectorShaftType.CURVED

Type:

VectorOptions

property visibility: bool

Visibility state.

Type:

bool

property x_plane: RangedValue

X plane range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.x_plane.value = 2.5
>>> cs.x_plane.range.min = -1.0
>>> cs.x_plane.range.max = 3.0

Type:

RangedValue

property y_plane: RangedValue

Y plane range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.y_plane.value = 0.0

Type:

RangedValue

property z_plane: RangedValue

Z plane range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_coord(ds)
>>> cs.z_plane.value = 1.0

Type:

RangedValue

class fieldview.utils.RuledGridOptions

Ruled grid options.

color: GeometricColor | int | None = None

Geometric color (1-10).

copy()

Return a detached copy of the options.

Return type:

RuledGridOptions

font: Font | str | None = None

Text font identifier.

horizontal_axis: RuledGridAxisOptions | None = None

Horizontal axis options.

show: bool = False

size: int | None = None

Font size.

vertical_axis: RuledGridAxisOptions | None = None

Vertical axis options.

class fieldview.utils.RuledGridAxisOptions

Ruled grid axis options.

copy()

Return a detached copy of the options.

Return type:

RuledGridAxisOptions

decimal_places: int | None = None

Decimal places for labels.

grid_lines: bool | None = None

Toggle grid lines.

interval: float | None = None

Numeric grid interval (0 disables).

label: Plane | str | None = None

constant.Plane label (x/y/z/r/t).

labels: bool | None = None

Toggle labels.

numerical_format: NumericalFormat | str | None = None

Numerical format for labels.

tick_marks: bool | None = None

Toggle tick marks.

Computational Surface Class

class fieldview.vis.Comp

Computational surface wrapper.

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds)
>>> cs.plane = fv.constant.Plane.I
>>> cs.i_plane.value = 10
>>> cs.coloring = fv.constant.Coloring.SCALAR
>>> cs.colormap.name = fv.constant.ColormapName.SPECTRUM

property I_inc: int

Sweep increment for the I axis.

Type:

int

property J_inc: int

Sweep increment for the J axis.

Type:

int

property K_inc: int

Sweep increment for the K axis.

Type:

int

property coloring: Coloring

Coloring mode (geometric, scalar, or material).

Type:

Coloring

property colormap: Colormap

Scalar colormap options.

Type:

Colormap

property contours: ContourColoring

Contour line coloring.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.contours = fv.constant.ContourColoring.SCALAR

Type:

ContourColoring

copy()

Return a new comp surface with the same settings.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds)
>>> copy_obj = cs.copy()

Return type:

Comp

delete()

Delete the comp surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds)
>>> cs.delete()

Return type:

None

property display_type: DisplayType

Surface display type.

Type:

DisplayType

export(filename, format='txt')

Export this comp surface to a text file.

Parameters:

• filename (str | PathLike[str]) – Destination export path.

• format (str) – Export format string. Only txt is currently supported.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds)
>>> cs.export("/tmp/comp_surface.txt", format="txt")

property geometric_color: GeometricColor

Geometric color used when not scalar-colored.

Type:

GeometricColor

property grid: int

Dataset-relative grid number (1-based).

This is the UI-oriented alias for grid_index. The two properties refer to the same selected dataset grid.

Example usage:

>>> cs = fv.vis.create_comp(ds, grid=1)
>>> cs.grid = 2

Type:

int

property grid_index: int

Dataset-relative grid index (0-based).

This is the Python-oriented alias for grid. The two properties refer to the same selected dataset grid.

Example usage:

>>> cs = fv.vis.create_comp(ds, grid_index=0)
>>> cs.grid_index = 1

Type:

int

property i_plane: RangedValue

I plane range controller.

Example usage:

>>> cs = fv.vis.create_comp(ds, plane=fv.constant.Plane.I)
>>> cs.i_plane.value = 10

Type:

RangedValue

integrate()

Integrate the current scalar function over this surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> surf = fv.vis.create_boundary(ds)
>>> surf.scalar_func = ds.scalar_functions[0]
>>> result = surf.integrate()
>>> result.surface
'boundary_surf'

Return type:

object

property j_plane: RangedValue

J plane range controller.

Example usage:

>>> cs = fv.vis.create_comp(ds, plane=fv.constant.Plane.J)
>>> cs.j_plane.value = 8

Type:

RangedValue

property k_plane: RangedValue

K plane range controller.

Example usage:

>>> cs = fv.vis.create_comp(ds, plane=fv.constant.Plane.K)
>>> cs.k_plane.value = 12

Type:

RangedValue

property legend: Legend

Legend options for scalar coloring.

Type:

Legend

property line_type: LineType

Line type used to render the graphic.

Type:

LineType

modify(*, grid=None, grid_index=None, plane=None, i_plane=None, j_plane=None, k_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, I_inc=None, J_inc=None, K_inc=None)

Modify multiple comp properties atomically.

grid and grid_index are interchangeable aliases for selecting the target dataset grid. grid is 1-based to match the UI, while grid_index is 0-based for Python-style indexing. When both are provided, they must refer to the same grid.

Parameters:

• grid (int | None) – Optional 1-based dataset grid number.

• grid_index (int | None) – Optional 0-based dataset grid index.

• plane (Plane | str | None) – Active plane selection.

• i_plane (RangedValue | None) – Optional I-plane ranged-value controller.

• j_plane (RangedValue | None) – Optional J-plane ranged-value controller.

• k_plane (RangedValue | None) – Optional K-plane ranged-value controller.

• coloring (Coloring | str | None) – Coloring mode for the comp surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the comp surface is visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• I_inc (int | None) – Sweep increment for the I axis.

• J_inc (int | None) – Sweep increment for the J axis.

• K_inc (int | None) – Sweep increment for the K axis.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds)
>>> cs.modify(visibility=False, transparency=0.2)

property phigs_obj: int

Public PHIGS object identifier for this graphic.

Type:

int

property plane: Plane

Active plane (i/j/k).

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.plane = fv.constant.Plane.I

Type:

Plane

property scalar_func: str | None

Selected scalar function name.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.scalar_func = ds.scalar_functions[0]

Type:

str | None

property scalar_minmax: ScalarMinMax

Scalar min/max options.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> smm = cs.scalar_minmax
>>> smm.show = True

Type:

ScalarMinMax

property show_mesh: bool

Mesh overlay visibility.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.show_mesh = True

Type:

bool

sweep(cycles=1, output_file=None, direction=None)

Sweep the comp surface and optionally write frames to a file.

Parameters:

• cycles (int) – Number of sweep cycles to run.

• output_file (str | PathLike[str] | None) – Optional movie or frame output path.

• direction (SweepDirection | None) – Optional sweep direction mode.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> cs = fv.vis.create_comp(ds, plane=fv.constant.Plane.I)
>>> cs.sweep(2, "/tmp/comp_sweep.mp4", fv.constant.SweepDirection.BOUNCE)

Notes

output_file must use .png, .mp4, or .avi.

property threshold: bool

Threshold enabled state.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.threshold = True

Type:

bool

property threshold_func: str | None

Selected threshold function name.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.threshold_func = ds.scalar_functions[0]

Type:

str | None

property threshold_range: Range

Threshold min/max range.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.threshold_range = fv.Range(min=0.2, max=0.8)

Type:

Range

property transparency: float

Transparency (0.0-1.0).

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.transparency = 0.35

Type:

float

property vector_func: str | None

Selected vector function name.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> cs.vector_func = ds.vector_functions[0]

Type:

str | None

property vector_options: VectorOptions

Vector display options.

Example usage:

>>> cs = fv.vis.create_comp(ds)
>>> opts = cs.vector_options
>>> opts.scale = 1.2

Type:

VectorOptions

property visibility: bool

Visibility state.

Type:

bool

Iso Surface Class

class fieldview.vis.Iso

Iso surface wrapper.

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> iso.coloring = fv.constant.Coloring.SCALAR
>>> iso.iso_value.value = 0.8

property coloring: Coloring

Coloring mode (geometric, scalar, or material).

Type:

Coloring

property colormap: Colormap

Scalar colormap options.

Type:

Colormap

property contours: ContourColoring

Contour line coloring.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.contours = fv.constant.ContourColoring.SCALAR

Type:

ContourColoring

copy()

Return a new iso surface with the same settings.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> copy_obj = iso.copy()

Return type:

Iso

property cutting_plane: CuttingPlane

Current cutting-plane definition.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.cutting_plane = fv.utils.CuttingPlane.point_and_normal((0, 0, 0), (1, 0, 0))

Type:

CuttingPlane

delete()

Delete this iso surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> iso.delete()

Return type:

None

property display_type: DisplayType

Surface display type.

Type:

DisplayType

export(filename, format='txt')

Export this iso surface to a text file.

Parameters:

• filename (str | PathLike[str]) – Destination export path.

• format (str) – Export format string. Only txt is currently supported.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> iso.export("/tmp/iso_surface.txt", format="txt")

property geometric_color: GeometricColor

Geometric color used when not scalar-colored.

Type:

GeometricColor

integrate()

Integrate the current scalar function over this surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> surf = fv.vis.create_boundary(ds)
>>> surf.scalar_func = ds.scalar_functions[0]
>>> result = surf.integrate()
>>> result.surface
'boundary_surf'

Return type:

object

integrate_partial_surface(point, tolerance=None)

Integrate the connected partial region containing point.

Returns None when point does not isolate a partial region on the current iso surface.

Parameters:

• point (object) – XYZ point used to identify the connected partial region.

• tolerance (float | None) – Optional coordinate tolerance used while locating the partial region.

Return type:

IntegrationResult | None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> probe = fv.data.probe_ijk((2, 3, 4), grid=1, dataset=ds)
>>> iso = fv.vis.create_iso(ds, iso_func=probe.scalar.func)
>>> iso.scalar_func = probe.scalar.func
>>> iso.iso_value.value = probe.scalar.value
>>> result = iso.integrate_partial_surface(tuple(probe.point))

property iso_func: str | CuttingPlane | None

Iso function selection.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.iso_func = ds.scalar_functions[1]

Type:

str | CuttingPlane | None

property iso_value: RangedValue

Iso value range controller.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.iso_value.value = 0.8

Type:

RangedValue

property legend: Legend

Legend options for scalar coloring.

Type:

Legend

property line_type: LineType

Line type used to render the graphic.

Type:

LineType

modify(*, iso_func=None, iso_value=None, cutting_plane=None, coloring=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, unrolled=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, sweep_steps=None)

Modify multiple iso-surface properties atomically.

Parameters:

• iso_func (str | CuttingPlane | dict[str, object] | None) – Iso function name, cutting plane, or cutting-plane payload dict.

• iso_value (RangedValue | None) – Optional iso-value ranged-value controller.

• cutting_plane (CuttingPlane | dict[str, object] | None) – Optional cutting-plane override.

• coloring (Coloring | str | None) – Coloring mode for the iso surface.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• unrolled (bool | None) – Whether unrolled display is enabled.

• visibility (bool | None) – Whether the iso surface is visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• sweep_steps (int | None) – Sweep step count.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> iso.modify(visibility=False, transparency=0.25)

property phigs_obj: int

Public PHIGS object identifier for this graphic.

Type:

int

property scalar_func: str | None

Selected scalar function name.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.scalar_func = ds.scalar_functions[0]

Type:

str | None

property scalar_minmax: ScalarMinMax

Scalar min/max options.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> smm = iso.scalar_minmax
>>> smm.show = True

Type:

ScalarMinMax

property show_mesh: bool

Mesh overlay visibility.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.show_mesh = True

Type:

bool

sweep(cycles=1, output_file=None, direction=None)

Sweep the iso surface and optionally write frames to a file.

Parameters:

• cycles (int) – Number of sweep cycles to run.

• output_file (str | PathLike[str] | None) – Optional movie or frame output path.

• direction (SweepDirection | None) – Optional sweep direction mode.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> iso = fv.vis.create_iso(ds, iso_func="Density (Q1)")
>>> iso.sweep(2, "/tmp/iso_sweep.mp4", fv.constant.SweepDirection.BOUNCE)

Notes

output_file must use .png, .mp4, or .avi.

property sweep_steps: int

Sweep step count.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.sweep_steps = 25

Type:

int

property threshold: bool

Threshold enabled state.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.threshold = True

Type:

bool

property threshold_func: str | None

Selected threshold function name.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.threshold_func = ds.scalar_functions[0]

Type:

str | None

property threshold_range: Range

Threshold min/max range.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.threshold_range = fv.Range(min=0.2, max=0.8)

Type:

Range

property transparency: float

Transparency (0.0-1.0).

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.transparency = 0.35

Type:

float

property unrolled: bool

Unrolled display state.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.unrolled = True

Type:

bool

property vector_func: str | None

Selected vector function name.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> iso.vector_func = ds.vector_functions[0]

Type:

str | None

property vector_options: VectorOptions

Vector display options.

Example usage:

>>> iso = fv.vis.create_iso(ds, iso_func=ds.scalar_functions[0])
>>> opts = iso.vector_options
>>> opts.scale = 1.2

Type:

VectorOptions

property visibility: bool

Visibility state.

Type:

bool

class fieldview.utils.CuttingPlane

Cutting-plane definition used by iso surfaces.

mode: str

static point_and_normal(point, normal)

Create a cutting plane from one point and a normal vector.

Parameters:

• point (TripletLike) – XYZ point lying on the plane.

• normal (TripletLike) – XYZ normal vector defining the plane orientation.

Return type:

CuttingPlane

static points_in_plane(pt1, pt2, pt3)

Create a cutting plane from three points lying in the plane.

Parameters:

• pt1 (TripletLike) – First XYZ point in the plane.

• pt2 (TripletLike) – Second XYZ point in the plane.

• pt3 (TripletLike) – Third XYZ point in the plane.

Return type:

CuttingPlane

pt1: tuple[float, float, float]

pt2: tuple[float, float, float]

pt3: tuple[float, float, float] = (0.0, 0.0, 0.0)

Boundary Surface Class

class fieldview.vis.Boundary

Boundary surface wrapper.

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>>
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.coloring = fv.constant.Coloring.SCALAR
>>> bnd.scalar_func = ds.scalar_functions[0]
>>> bnd.display_type = fv.constant.DisplayType.MESH
>>> bnd.transparency = 0.25
>>> bnd.colormap.name = fv.constant.ColormapName.SPECTRUM

property available_types: list[str]

All boundary type names available in the dataset.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.available_types

Type:

list[str]

property coloring: Coloring

Coloring mode (geometric, scalar, or material).

Type:

Coloring

property colormap: Colormap

Scalar colormap options.

Type:

Colormap

property contours: ContourColoring

Contour color mode.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.contours = "scalar"

Type:

ContourColoring

copy()

Return a new boundary surface with the same settings.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> copy_obj = bnd.copy()

Return type:

Boundary

delete()

Delete this boundary surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.delete()

Return type:

None

property display_type: DisplayType

Surface display type.

Type:

DisplayType

export(filename, format='txt')

Export this boundary surface to a file.

Parameters:

• filename (str | PathLike[str]) – Destination export path.

• format (str) – Export format string. Supported values are txt, mat, and csv. Structured datasets support txt only; mat and csv require an unstructured dataset.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.export("/tmp/boundary_surface.csv", format="csv")

property geometric_color: GeometricColor

Geometric color used when not scalar-colored.

Type:

GeometricColor

integrate()

Integrate the current scalar function over this surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> surf = fv.vis.create_boundary(ds)
>>> surf.scalar_func = ds.scalar_functions[0]
>>> result = surf.integrate()
>>> result.surface
'boundary_surf'

Return type:

object

property legend: Legend

Legend options for scalar coloring.

Type:

Legend

property line_type: LineType

Line type used to render the graphic.

Type:

LineType

property material: str | None

Material name used when coloring is material.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.material = "Gold"

Type:

str | None

modify(*, x_clip=None, y_clip=None, z_clip=None, r_clip=None, t_clip=None, coloring=None, material=None, geometric_color=None, display_type=None, line_type=None, contours=None, show_mesh=None, visibility=None, transparency=None, scalar_func=None, vector_func=None, threshold=None, threshold_func=None, threshold_range=None, vector_options=None, scalar_minmax=None, colormap=None, legend=None, types=None)

Modify multiple boundary properties atomically.

Parameters:

• x_clip (Range | dict[str, object] | None) – Optional X clipping range.

• y_clip (Range | dict[str, object] | None) – Optional Y clipping range.

• z_clip (Range | dict[str, object] | None) – Optional Z clipping range.

• r_clip (Range | dict[str, object] | None) – Optional R clipping range.

• t_clip (Range | dict[str, object] | None) – Optional T clipping range.

• coloring (Coloring | str | None) – Coloring mode for the boundary surface.

• material (Material | str | None) – Material selection used when material coloring is active.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• display_type (DisplayType | str | None) – Surface display type.

• line_type (LineType | str | None) – Line style used for wireframe-capable display modes.

• contours (ContourColoring | str | None) – Contour coloring mode.

• show_mesh (bool | None) – Whether the mesh overlay is shown.

• visibility (bool | None) – Whether the boundary surface is visible.

• transparency (float | None) – Surface transparency amount.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for vector display modes.

• threshold (bool | None) – Whether thresholding is enabled.

• threshold_func (str | None) – Scalar function name used for thresholding.

• threshold_range (Range | None) – Threshold value range.

• vector_options (VectorOptions | None) – Vector display options.

• scalar_minmax (ScalarMinMax | None) – Scalar min/max annotation options.

• colormap (Colormap | None) – Scalar colormap options.

• legend (Legend | None) – Legend options.

• types (BoundaryTypeSelection | str | list[str] | tuple[str, ...] | None) – Boundary-type selection or explicit boundary-type names.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.modify(coloring=fv.constant.Coloring.SCALAR, transparency=0.3)

property phigs_obj: int

Public PHIGS object identifier for this graphic.

Type:

int

property r_clip: Range

R clip range controller (cylindrical datasets).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.r_clip.min = bnd.r_clip.min + 0.1

Type:

Range

property scalar_func: str | None

Selected scalar function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.scalar_func = ds.scalar_functions[0]

Type:

str | None

property scalar_minmax: ScalarMinMax

Scalar min/max annotation options.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.scalar_minmax.show = True
>>> bnd.scalar_minmax.min.text = "Min: %%SCALAR_MIN"

Type:

ScalarMinMax

property show_mesh: bool

Mesh overlay visibility.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.show_mesh = True

Type:

bool

property t_clip: Range

Theta clip range controller (cylindrical datasets).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.t_clip.min = bnd.t_clip.min + 1.0

Type:

Range

property threshold: bool

Threshold enabled state.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.threshold = True

Type:

bool

property threshold_func: str | None

Selected threshold function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.threshold_func = "Density (Q1)"

Type:

str | None

property threshold_range: Range

Threshold range.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.threshold_range = bnd.threshold_range

Type:

Range

property transparency: float

Surface transparency (0.0-1.0).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.transparency = 0.25

Type:

float

property types: list[str]

Active boundary type names.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds)
>>> bnd.types = ds.boundary_types # equivalent to fv.constant.BoundaryTypeSelection.ALL

Type:

list[str]

property vector_func: str | None

Selected vector function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.vector_func = "Momentum Vectors [PLOT3D]"

Type:

str | None

property vector_options: VectorOptions

Vector display options.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.vector_options.head_type = fv.constant.VectorHeadType.HEAD3D

Type:

VectorOptions

property visibility: bool

Visibility state.

Type:

bool

property x_clip: Range

X clip range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.x_clip = fv.Range(-1.0, 1.0)

Type:

Range

property y_clip: Range

Y clip range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.y_clip.min = bnd.y_clip.min + 0.1

Type:

Range

property z_clip: Range

Z clip range controller.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> bnd.z_clip.min = bnd.z_clip.min + 0.1

Type:

Range

Surface Flows Class

class fieldview.vis.SurfaceFlows

Surface restricted flow path wrapper.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sf = fv.vis.create_surface_flows(
...     ds,
...     mode=fv.constant.SurfaceFlowMode.NO_SLIP,
...     vector_func="Velocity Vectors [PLOT3D]",
... )
>>> sf.direction = fv.constant.CalculationDirection.BOTH
>>> sf.calculate()

calculate()

Calculate or recalculate the current surface-flow paths.

Return type:

None

copy()

Return a new surface-flow object with the same public settings.

Return type:

SurfaceFlows

delete()

Delete this surface-flow object.

Return type:

None

property direction: CalculationDirection

Integration direction.

Type:

CalculationDirection

property display_type: PathsDisplayType

Display representation for surface flows.

Only COMPLETE is supported.

Type:

PathsDisplayType

property mode: SurfaceFlowMode

Surface-flow extraction mode.

Type:

SurfaceFlowMode

modify(*, mode=<object object>, visibility=None, line_type=None, geometric_color=None, coloring=None, scalar_func=None, scalar_path_variable=None, vector_func=None, direction=None, time_limit_enabled=None, time_limit=<object object>, seeding=None, seed_file=<object object>, offset_distance=None, step=None, colormap=None, legend=None, calculate=False)

Modify multiple surface-flow settings in one call.

Set calculate=True to run the calculation after the settings update.

Parameters:

• mode (object) – Optional surface-flow extraction mode.

• visibility (bool | None) – Whether the object is visible.

• line_type (LineType | str | None) – Line style used for the extracted paths.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted paths.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• scalar_path_variable (str | None) – Path-variable name used for scalar coloring.

• vector_func (str | None) – Vector function name used for path calculation.

• direction (CalculationDirection | str | None) – Integration direction.

• time_limit_enabled (bool | None) – Whether the time-limit field is enabled.

• time_limit (float | None | object) – Optional tracing time limit.

• seeding (SurfaceFlowSeeding | str | None) – Seeding mode.

• seed_file (str | PathLike[str] | None | object) – Optional seed-file path.

• offset_distance (float | None) – Surface offset distance.

• step (int | None) – Integration step count.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

• calculate (bool) – When True, run the calculation after updating the settings.

Return type:

None

property offset_distance: float

Surface offset distance used by OFFSET mode.

Type:

float

property scalar_func: str | None

Dataset scalar function cached for registry loading.

Type:

Optional[str]

property scalar_path_variable: str | None

Active scalar coloring selection for dataset or feature variables.

Type:

Optional[str]

property seed_file: str | None

Seed-file path when seeding is FROM_FILE.

Type:

Optional[str]

property seeding: SurfaceFlowSeeding

Seeding density/source mode.

Type:

SurfaceFlowSeeding

property step: int

Integration step count.

Type:

int

property time_limit: float | None

Duration-limit value, or None when disabled.

Type:

Optional[float]

property time_limit_enabled: bool

Enable the duration-limit field.

Type:

bool

property vector_func: str | None

Vector function used for the path calculation.

Type:

Optional[str]

class fieldview.vis.SeparationLines

Separation-line path wrapper.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sep = fv.vis.create_separation_lines(ds)
>>> sep.coloring = fv.constant.Coloring.SCALAR

copy()

Return a new separation-line object with the same settings.

Return type:

SeparationLines

delete()

Delete this separation-line object.

Return type:

None

property display_type: PathsDisplayType

Display representation for separation lines.

Type:

PathsDisplayType

modify(*, visibility=None, line_type=None, geometric_color=None, coloring=None, colormap=None, legend=None)

Modify multiple separation-line display settings.

Parameters:

• visibility (bool | None) – Whether the object is visible.

• line_type (LineType | str | None) – Line style used for the extracted lines.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted lines.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

None

class fieldview.vis.ReattachmentLines

Reattachment-line path wrapper.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> reatt = fv.vis.create_reattachment_lines(ds)
>>> reatt.line_type = fv.constant.LineType.THICK

copy()

Return a new reattachment-line object with the same settings.

Return type:

ReattachmentLines

delete()

Delete this reattachment-line object.

Return type:

None

property display_type: PathsDisplayType

Display representation for reattachment lines.

Type:

PathsDisplayType

modify(*, visibility=None, line_type=None, geometric_color=None, coloring=None, colormap=None, legend=None)

Modify multiple reattachment-line display settings.

Parameters:

• visibility (bool | None) – Whether the object is visible.

• line_type (LineType | str | None) – Line style used for the extracted lines.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• coloring (Coloring | str | None) – Coloring mode for the extracted lines.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

None

Streamlines Surface Class

class fieldview.vis.Streamlines

Streamlines surface wrapper.

Notes

seed_coord cannot be changed while the streamline object still has seeds. Delete them first with delete_all_seeds().

seed_surface() requires a live Boundary, Comp, Coord, or Iso surface from the same dataset as the streamline object.

Streak controls use a single validation rule: release_interval > 0 and 0 < duration < release_interval. Invalid values are rejected before any core update, and copy() raises if the source object violates that contract.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(
...     ds,
...     vector_func=ds.vector_functions[0],
...     coloring=fv.constant.Coloring.SCALAR,
...     scalar_func=ds.scalar_functions[0],
...     display_type=fv.constant.PathsDisplayType.FILAMENT,
...     seed_coord=fv.constant.StreamlinesSeedCoord.IJK_REAL,
... )
>>> sl.add_seeds([(1.0, 1.0, 1.0), (40.0, 20.0, 10.0)], grid=1)
>>> sl.calculate()

add_seeds(seeds, *, grid=1, grids=None)

Add one or more seed points.

Parameters:

• seeds (Sequence[Sequence[int | float]]) – Sequence of seed coordinates. Use XYZ values when seed_coord is xyz; otherwise use IJK or IJK-real triplets.

• grid (int) – Default grid number to apply to all seeds when the active seed coordinate mode requires grid ids.

• grids (Sequence[int] | None) – Optional per-seed grid numbers. When provided, the length must match seeds.

Return type:

None

Example usage:

>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0), (10.0, 8.0, 6.0)], grid=1)

property animate: bool

Animate path traversal in the viewer.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.animate = True

Type:

bool

property animate_direction: AnimationDirection

Direction of streamline animation.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.animate_direction = "forward"

Type:

AnimationDirection

property animate_divs: int

Number of animation divisions.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.animate_divs = 30

Type:

int

calculate()

Run streamline calculation using current seeds and parameters.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()

Return type:

None

copy()

Return a new streamlines surface with the same settings and seeds.

Raises InvalidArgumentError if the current streak controls are not valid for the Python API contract.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> copy_obj = sl.copy()

Return type:

Streamlines

delete()

Delete this streamlines surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.delete()

Return type:

None

delete_all_seeds()

Delete all seeds.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.delete_all_seeds()

Return type:

None

property direction: CalculationDirection

Trace direction for calculation.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.direction = "both"

Type:

CalculationDirection

property display_type: PathsDisplayType

Path display style.

Example usage:

>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.display_type = fv.constant.PathsDisplayType.FILAMENT

Type:

PathsDisplayType

property duration: int

Streakline duration.

Must be > 0 and < release_interval.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.duration = 1

Type:

int

export(filename, format='fvp')

Export this streamlines surface to an FVP file.

Parameters:

• filename (str | PathLike[str]) – Destination export path.

• format (str) – Export format string. Only fvp is currently supported.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.calculate()
>>> sl.export("/tmp/streamlines.fvp", format="fvp")

modify(*, coloring=None, geometric_color=None, line_type=None, display_type=None, sphere_scale=None, ribbon_width=None, transparency=None, visibility=None, scalar_func=None, vector_func=None, animate=None, animate_direction=None, animate_divs=None, show_seeds=None, seed_coord=None, direction=None, step=None, time_limit=<object object>, release_interval=None, duration=None, colormap=None, legend=None, calculate=False)

Update multiple properties in one call.

Calculation runs implicitly when any calculation parameter (direction, step, time_limit, release_interval, duration) is changed, or when calculate=True.

Parameters:

• coloring (Coloring | str | None) – Coloring mode for the streamline geometry.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• line_type (LineType | str | None) – Streamline line style.

• display_type (PathsDisplayType | str | None) – Path display type such as complete, filament, or ribbon.

• sphere_scale (float | None) – Sphere or arrow size scale.

• ribbon_width (int | None) – Ribbon width used by ribbon display modes.

• transparency (float | None) – Transparency amount for the streamline geometry.

• visibility (bool | None) – Whether the streamline object is visible.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• vector_func (str | None) – Vector function name used for streamline integration.

• animate (bool | None) – Whether streamline animation is enabled.

• animate_direction (AnimationDirection | str | None) – Direction used for streamline animation.

• animate_divs (int | None) – Number of animation divisions.

• show_seeds (bool | None) – Whether seed markers are shown.

• seed_coord (StreamlinesSeedCoord | str | None) – Seed coordinate system to use for subsequent seed operations.

• direction (CalculationDirection | str | None) – Integration direction used for calculation.

• step (int | None) – Integration step size.

• time_limit (float | None | object) – Optional tracing time limit. Pass None to clear the current limit.

• release_interval (int | None) – Optional streakline release interval.

• duration (int | None) – Optional streakline duration.

• colormap (Colormap | dict[str, object] | None) – Optional colormap settings as a Colormap or payload dict.

• legend (Legend | dict[str, object] | None) – Optional legend settings as a Legend or payload dict.

• calculate (bool) – When True, run streamline calculation after applying the updates.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.modify(visibility=False, show_seeds=False)

release_interval and duration are validated together before any core call. Invalid combinations are rejected without partial updates.

property num_seeds: int

Number of seeds currently assigned (read-only).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.num_seeds

Type:

int

property release_interval: int

Streakline release interval.

Must be > 0, and the paired duration must remain smaller than this value.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.release_interval = 3

Type:

int

property ribbon_width: int

Ribbon width for ribbon display mode.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.ribbon_width = 24

Type:

int

property scalar_func: str | None

Selected scalar function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.scalar_func = "Density (Q1)"

Type:

str | None

property seed_coord: StreamlinesSeedCoord

Coordinate system used by seed operations.

Changing seed_coord while seeds exist is rejected by the core. Delete existing seeds first with delete_all_seeds().

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.seed_coord

Type:

StreamlinesSeedCoord

seed_surface(surface, *, inc=3, num_seeds=10)

Seed from another live surface (Boundary, Comp, Coord, or Iso).

The surface must not be deleted and must belong to the same dataset as this streamline object.

Parameters:

• surface (SurfaceBase) – Source surface used to generate streamline seeds.

• inc (int) – Grid-space increment used when seed_coord is ijk.

• num_seeds (int) – Number of seeds to distribute when seed_coord is ijk_real or xyz.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> bnd = fv.vis.create_boundary(ds, types=fv.constant.BoundaryTypeSelection.ALL)
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.seed_surface(surface=bnd)

property show_seeds: bool

Show or hide seed points in the viewer.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.show_seeds = True

Type:

bool

property sphere_scale: float

Sphere/arrow size scale.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.sphere_scale = 1.25

Type:

float

property step: int

Integration step size.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.step = 3

Type:

int

property streak: StreamlinesStreak

Convenience access to streak controls.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> streak = sl.streak

Type:

StreamlinesStreak

property time_limit: float | None

Optional time limit for tracing.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.time_limit = 0.25

Type:

float | None

property transparency: float

Transparency percentage.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.transparency = 0.2

Type:

float

property vector_func: str | None

Selected vector function name.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> sl = fv.vis.create_streamlines(ds, vector_func=ds.vector_functions[0])
>>> sl.seed_coord = fv.constant.StreamlinesSeedCoord.IJK_REAL
>>> sl.add_seeds([(5.0, 5.0, 5.0)], grid=1)
>>> sl.calculate()
>>> sl.vector_func = "Momentum Vectors [PLOT3D]"

Type:

str | None

Particle Paths Surface Class

class fieldview.vis.ParticlePaths

Particle paths surface wrapper.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.display_type = fv.constant.PathsDisplayType.SPHERES_AND_LINES

property animate: bool

Animation toggle for particle paths.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.animate = True

Type:

bool

property animate_direction: AnimationDirection

Animation direction (forward or backward).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.animate_direction = fv.constant.AnimationDirection.FORWARD

Type:

constant.AnimationDirection

property animate_divs: int

Number of animation divisions.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.animate_divs = 25

Type:

int

copy()

Return a new particle-paths surface with the same settings.

Example usage:

>>> copy_obj = ppath.copy()

Return type:

ParticlePaths

delete()

Delete this particle-path surface.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.delete()

Return type:

None

property display_type: PathsDisplayType

Display representation for particle paths.

Example usage:

>>> ppath = fv.vis.create_particle_paths(ds, filename="paths.fvp")
>>> ppath.display_type = fv.constant.PathsDisplayType.SPHERES_AND_LINES

Type:

PathsDisplayType

modify(*, coloring=None, geometric_color=None, line_type=None, display_type=None, sphere_scale=None, transparency=None, visibility=None, scalar_func=None, animate=None, animate_direction=None, animate_divs=None, subset_inc=None, select_by_initial_value=None, select_by_initial_value_variable=None, select_by_initial_value_min=None, select_by_initial_value_max=None, select_by_value_on_path=None, select_by_value_on_path_variable=None, select_by_value_on_path_min=None, select_by_value_on_path_max=None, select_by_tags=None, tags=None, colormap=None, legend=None)

Modify multiple particle-path display attributes in one call.

Parameters:

• coloring (Coloring | str | None) – Coloring mode for the particle paths.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• line_type (LineType | str | None) – Line style used for the particle paths.

• display_type (PathsDisplayType | str | None) – Path display type such as complete or filament.

• sphere_scale (float | None) – Sphere or marker size scale.

• transparency (float | None) – Particle-path transparency amount.

• visibility (bool | None) – Whether the particle paths are visible.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• animate (bool | None) – Whether particle-path animation is enabled.

• animate_direction (AnimationDirection | str | None) – Direction used for animation.

• animate_divs (int | None) – Number of animation divisions.

• subset_inc (int | None) – Subsampling increment for displayed paths.

• select_by_initial_value (bool | None) – Whether initial-value filtering is enabled.

• select_by_initial_value_variable (str | None) – Variable name used for initial-value filtering.

• select_by_initial_value_min (float | None) – Initial-value filter minimum.

• select_by_initial_value_max (float | None) – Initial-value filter maximum.

• select_by_value_on_path (bool | None) – Whether value-on-path filtering is enabled.

• select_by_value_on_path_variable (str | None) – Variable name used for value-on-path filtering.

• select_by_value_on_path_min (float | None) – Value-on-path filter minimum.

• select_by_value_on_path_max (float | None) – Value-on-path filter maximum.

• select_by_tags (bool | None) – Whether tag-based filtering is enabled.

• tags (str | Sequence[str] | None) – Tag names to select when tag-based filtering is used.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

None

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.modify(visibility=True, animate=True, animate_divs=20)

property path_variables: list[str]

Imported particle-path variable names (read-only).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.path_variables

Type:

list[str]

property scalar_func: str | None

Scalar variable name used for scalar coloring.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.scalar_func = "Duration"

Type:

Optional[str]

property select_by_initial_value: bool

Enable or disable Select By Initial Value.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_initial_value = True

Type:

bool

property select_by_initial_value_range: Range

Current and absolute range for Select By Initial Value (read-only).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_initial_value_range

Type:

Range

property select_by_initial_value_variable: str | None

Variable name used by Select By Initial Value.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_initial_value_variable = "Duration"

Type:

Optional[str]

property select_by_tags: bool

Enable or disable Select By Tag filtering.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_tags = True

Type:

bool

property select_by_value_on_path: bool

Enable or disable Select By Value on Path.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_value_on_path = True

Type:

bool

property select_by_value_on_path_range: Range

Current and absolute range for Select By Value on Path (read-only).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_value_on_path_range

Type:

Range

property select_by_value_on_path_variable: str | None

Variable name used by Select By Value on Path.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.select_by_value_on_path_variable = "Duration"

Type:

Optional[str]

property selected_tags: list[str]

Currently selected tag names.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.selected_tags = ["stream_1", "stream_2"]

Type:

list[str]

property sphere_scale: float

Scale factor for spheres/arrows in path displays.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.sphere_scale = 1.25

Type:

float

property subset_inc: int

Subset increment used when displaying path samples.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.subset_inc = 1

Type:

int

property tags: list[str]

Available imported tag names (read-only).

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.tags

Type:

list[str]

property transparency: float

Surface transparency in range 0.0 to 1.0.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> ppath = fv.vis.create_particle_paths(ds, filename="/path/to/particle_paths.fvp")
>>> ppath.transparency = 0.25

Type:

float

2D Plot Class

class fieldview.vis.Plot2D

2D plot wrapper.

Use create_plot2d() to create instances. A plot owns zero or more Plot2DPath objects and exposes nested axis, sampling, annotation, and border settings through helper objects.

Example usage:

>>> plot = fv.vis.create_plot2d(
...     left_axis_func="Pressure",
...     right_axis_func="Density",
...     show_plot=True,
... )
>>> path = plot.create_line_path_volume((0.0, 0.0, 0.0), (1.0, 0.0, 0.0))
>>> plot.left_axis.label = "Pressure"
>>> plot.right_axis_func = None

annotation

property background: bool

Whether the plot uses background drawing mode.

Type:

bool

create_line_path_volume(start, end, **_options)

Create a volume line path from two dataset-coordinate points.

Parameters:

• start (TripletLike) – Three-number start point in dataset coordinates. For Cartesian datasets this is (x, y, z). For cylindrical datasets this is the displayed cylindrical triplet, such as (r, theta, z) or (r, theta, x).

• end (TripletLike) – Three-number end point in dataset coordinates. For Cartesian datasets this is (x, y, z). For cylindrical datasets this is the displayed cylindrical triplet, such as (r, theta, z) or (r, theta, x).

• **_options (object) – Reserved for future compatibility. Currently ignored.

Return type:

Plot2DPath

Notes

Some non-fatal host diagnostics are returned as Python warnings rather than exceptions. In interactive FieldView sessions those warnings may appear in the Python console.

property dataset_id: int

Dataset identifier backing this plot.

Type:

int

delete()

Delete this plot and invalidate all known path handles.

Return type:

None

delete_all_paths()

Delete all paths owned by this plot.

Return type:

None

delete_path(path)

Delete one path owned by this plot.

Parameters:

path (Plot2DPath) – Path handle owned by this Plot2D.

Return type:

None

horizontal_axis

property horizontal_axis_mode: Plot2DHorizontalAxis

Quantity shown on the horizontal axis.

Type:

Plot2DHorizontalAxis

import_path_txt(filename)

Import one path from a FieldView path text file.

Parameters:

filename (str | PathLike[str]) – FieldView path text file to import.

Return type:

Plot2DPath

left_axis

property left_axis_func: str

Scalar function used on the left axis.

Type:

str

modify(*, left_axis_func=<object object>, right_axis_func=<object object>, show_right_axis=<object object>, show_path=<object object>, show_plot=<object object>, background=<object object>, horizontal_axis_mode=<object object>, path_style=<object object>, sampling=<object object>, annotation=<object object>, options=<object object>, horizontal_axis=<object object>, left_axis=<object object>, right_axis=<object object>)

Modify multiple plot settings in one host round trip.

Supported keyword arguments mirror create_plot2d(), plus horizontal_axis, left_axis, and right_axis nested payloads.

Parameters:

• left_axis_func (str | None | object) – Left-axis scalar function name.

• right_axis_func (str | None | object) – Right-axis scalar function name, or None to clear.

• show_right_axis (bool | None | object) – Show/hide the right axis.

• show_path (bool | None | object) – Show/hide path geometry in the host plot.

• show_plot (bool | None | object) – Show/hide the plot in the host.

• background (bool | None | object) – Toggle background drawing mode.

• horizontal_axis_mode (Plot2DHorizontalAxis | str | None | object) – Horizontal axis quantity selector.

• path_style (Plot2DPathStyle | str | None | object) – Path draw style.

• sampling (Plot2DSamplingOptions | Mapping[str, object] | None | object) – Nested sampling payload as a mapping or fieldview.utils.Plot2DSamplingOptions.

• annotation (Plot2DAnnotationOptions | Mapping[str, object] | None | object) – Nested annotation payload as a mapping or fieldview.utils.Plot2DAnnotationOptions.

• options (Plot2DOptions | Mapping[str, object] | None | object) – Nested border/layout payload as a mapping or fieldview.utils.Plot2DOptions.

• horizontal_axis (Plot2DAxisOptions | Mapping[str, object] | None | object) – Nested axis payload as a mapping or fieldview.utils.Plot2DAxisOptions.

• left_axis (Plot2DAxisOptions | Mapping[str, object] | None | object) – Nested axis payload as a mapping or fieldview.utils.Plot2DAxisOptions.

• right_axis (Plot2DAxisOptions | Mapping[str, object] | None | object) – Nested axis payload as a mapping or fieldview.utils.Plot2DAxisOptions.

Return type:

None

options

property path_style: Plot2DPathStyle

Drawing style applied to plotted path data.

Type:

Plot2DPathStyle

property paths: tuple[Plot2DPath, ...]

Read-only view of the plot’s current paths.

Type:

tuple[Plot2DPath, …]

property plot_id: int

Host-assigned 2D plot identifier.

Type:

int

right_axis

property right_axis_func: str | None

Scalar function used on the right axis, or None when disabled.

Type:

Optional[str]

sampling

property show_path: bool

Whether path geometry is shown in the host plot view.

Type:

bool

property show_plot: bool

Whether the plot is displayed in the host.

Type:

bool

property show_right_axis: bool

Whether the right axis is visible.

Type:

bool

class fieldview.vis.Plot2DPath

Path handle owned by a Plot2D.

A path may be either a native volume line created from two XYZ points or an imported path loaded from a FieldView path text file.

Example usage:

>>> plot = fv.vis.create_plot2d(left_axis_func="Pressure")
>>> path = plot.create_line_path_volume((0.0, 0.0, 0.0), (1.0, 0.0, 0.0))
>>> path.name = "centerline"
>>> path.export_txt("centerline.txt")

property end: tuple[float, float, float] | None

End point in dataset coordinates.

For Cartesian datasets this is (x, y, z). For cylindrical datasets this is the displayed cylindrical triplet, such as (r, theta, z) or (r, theta, x).

Type:

Optional[tuple[float, float, float]]

export_txt(filename)

Export this path to a FieldView path text file.

Parameters

filename:

Destination text file path.

Parameters:

filename (str | PathLike[str])

Return type:

None

property kind: Plot2DPathKind

Path type reported by the host.

Type:

Plot2DPathKind

property name: str | None

User-visible path name, or None when unset.

Type:

Optional[str]

property path_id: int

Host-assigned path identifier within the owning plot.

Type:

int

property plot: Plot2D

Owning plot object.

Type:

Plot2D

property start: tuple[float, float, float] | None

Start point in dataset coordinates.

For Cartesian datasets this is (x, y, z). For cylindrical datasets this is the displayed cylindrical triplet, such as (r, theta, z) or (r, theta, x).

Type:

Optional[tuple[float, float, float]]

class fieldview.vis.Plot2DAxis

Axis settings for a Plot2D.

Instances are available from Plot2D.horizontal_axis, Plot2D.left_axis, and Plot2D.right_axis.

Example usage:

>>> plot = fv.vis.create_plot2d(left_axis_func="Pressure", show_plot=True)
>>> plot.left_axis.label = "Pressure"
>>> plot.left_axis.major_grid_lines.enabled = True

property color: int

FieldView color index for the axis.

Type:

int

property label: str

Axis label text.

Type:

str

major_grid_lines

major_tick_marks

property max: float | None

Explicit maximum axis value, or None for host defaults.

Type:

Optional[float]

property min: float | None

Explicit minimum axis value, or None for host defaults.

Type:

Optional[float]

minor_grid_lines

minor_tick_marks

property normalize: float | None

Axis normalization factor, or None for host defaults.

Type:

Optional[float]

class fieldview.vis.Plot2DSampling

Sampling controls for a Plot2D.

Example usage:

>>> plot = fv.vis.create_plot2d(left_axis_func="Pressure")
>>> plot.sampling.mode = fv.constant.Plot2DSamplingMode.UNIFORM
>>> plot.sampling.number_samples = 40

property mode: Plot2DSamplingMode

Sampling mode used for plot evaluation.

Type:

Plot2DSamplingMode

property number_samples: int

Number of samples when uniform sampling is enabled.

Type:

int

class fieldview.vis.Plot2DAnnotation

Annotation settings for a Plot2D.

Supported attributes are show_date, show_legend, title, title_color, subtitle, and subtitle_color.

Example usage:

>>> plot = fv.vis.create_plot2d(left_axis_func="Pressure")
>>> plot.annotation.title = "Pressure Along Path"
>>> plot.annotation.show_legend = True

class fieldview.vis.Plot2DOptions

Border and framing options for a Plot2D.

Example usage:

>>> plot = fv.vis.create_plot2d(left_axis_func="Pressure")
>>> plot.options.border_layout = fv.constant.Plot2DBorderLayout.ACTIVE_AXES
>>> plot.options.border_style = fv.constant.Plot2DLineStyle.DASHED

Vortex Cores Class

class fieldview.vis.VortexCores

Vortex cores surface wrapper.

Example usage:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> vc = fv.vis.create_vortex_cores(
...     ds,
...     method="Vorticity Alignment",
...     vector_func="Vorticity Vectors [PLOT3D]",
... )
>>> vc.coloring = fv.constant.Coloring.SCALAR

copy()

Return a new vortex-cores surface with the same settings.

Example usage:

>>> copy_obj = vc.copy()

Return type:

VortexCores

delete()

Delete this vortex-cores surface.

Example usage:

>>> vc.delete()

Return type:

None

property display_type: PathsDisplayType

Display representation for vortex cores.

Only COMPLETE is supported.

Example usage:

>>> vc.display_type = fv.constant.PathsDisplayType.COMPLETE

Type:

PathsDisplayType

property method: str | None

Active vortex-core extraction method.

Example usage:

>>> vc.method

Type:

Optional[str]

property min_vortex_strength: float

Current MIN VORTEX STRENGTH slider value.

Example usage:

>>> vc.min_vortex_strength = 0.5

Type:

float

property min_vortex_strength_enabled: bool

Enable/disable the MIN VORTEX STRENGTH filter.

Example usage:

>>> vc.min_vortex_strength_enabled = True

Type:

bool

modify(*, visibility=None, line_type=None, geometric_color=None, min_vortex_strength_enabled=None, min_vortex_strength=None, coloring=None, scalar_func=None, scalar_path_variable=None, vector_func=None, colormap=None, legend=None)

Modify multiple vortex-cores display attributes in one call.

Parameters:

• visibility (bool | None) – Whether the object is visible.

• line_type (LineType | str | None) – Line style used for the extracted cores.

• geometric_color (GeometricColor | int | None) – Geometric color id used when geometric coloring is active.

• min_vortex_strength_enabled (bool | None) – Whether the minimum-vortex-strength filter is enabled.

• min_vortex_strength (float | None) – Minimum vortex-strength filter value.

• coloring (Coloring | str | None) – Coloring mode for the extracted cores.

• scalar_func (str | None) – Scalar function name used for scalar coloring.

• scalar_path_variable (str | None) – Path-variable name used for scalar coloring.

• vector_func (str | None) – Vector variable name used for the extraction or display.

• colormap (Colormap | dict[str, object] | None) – Scalar colormap options.

• legend (Legend | dict[str, object] | None) – Legend options.

Return type:

None

Example usage:

>>> vc.modify(
...     visibility=True,
...     coloring="scalar",
...     scalar_path_variable="Vortex Strength",
... )

property scalar_func: str | None

Dataset scalar function cached for registry loading.

Example usage:

>>> vc.scalar_func = "Density (Q1)"

Type:

Optional[str]

property scalar_path_variable: str | None

Active scalar coloring selection for dataset or feature variables.

Example usage:

>>> vc.scalar_path_variable = "Vortex Strength"

Type:

Optional[str]

property vector_func: str | None

Vector variable name.

Example usage:

>>> vc.vector_func = "Velocity"

Type:

Optional[str]

Annotation Class

class fieldview.vis.AnnotationText

Text annotation wrapper.

property align: AnnotationTextAlign

Text alignment.

Type:

AnnotationTextAlign

property direction: AnnotationTextDirection

Text direction.

Type:

AnnotationTextDirection

property font: Font

Text font.

Type:

Font

property font_size: int

Font size.

Type:

int

modify(*, text=None, visibility=None, position=None, color=None, font=None, font_size=None, align=None, direction=None)

Update multiple text annotation properties in one call.

Parameters:

• text (str | None)

• visibility (bool | None)

• position (object)

• color (GeometricColor | int | None)

• font (Font | str | None)

• font_size (int | None)

• align (AnnotationTextAlign | str | None)

• direction (AnnotationTextDirection | str | None)

Return type:

None

property position: tuple[float, float]

Text anchor position in screen coordinates.

Type:

tuple[float, float]

property text: str

Displayed annotation string.

Type:

str

class fieldview.vis.AnnotationArrow

Arrow annotation wrapper.

modify(*, visibility=None, position=None, color=None, tip=None, tail=None)

Update multiple arrow annotation properties in one call.

Parameters:

• visibility (bool | None)

• position (object)

• color (GeometricColor | int | None)

• tip (object)

• tail (object)

Return type:

None

property position: dict[str, tuple[float, float]]

Arrow tip and tail screen coordinates.

Type:

dict[str, tuple[float, float]]

Layout

fieldview.layout

Layout management helpers for interactive or batch FieldView sessions.

The functions in this module operate on graphics windows within the current FieldView layout. Window numbers are 1-based and match the numbering used by the host UI. The current window is the default target whenever an operation accepts window=None.

Use fieldview.layout when you need to inspect the current pane layout, switch the active window, split a view into additional panes, close panes, or configure multi-window view synchronization.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_vertical(mode="copy")
>>> fv.layout.select(split.new_window)

fieldview.layout.get_windows()

Return metadata for all graphics windows in the current layout.

This works in both interactive and batch graphics sessions.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> windows = fv.layout.get_windows()

Return type:

WindowList

fieldview.layout.current()

Return the 1-based number of the current graphics window.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> window = fv.layout.current()

Return type:

int

fieldview.layout.select(window)

Make window the current graphics window.

Parameters:

window (int) – 1-based graphics window number to select.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_vertical(mode="copy")
>>> fv.layout.select(split.source_window)

fieldview.layout.split_vertical(mode='copy', window=None)

Split a window vertically and return metadata for the new window.

window=None targets the current window. The new window becomes current on success.

Parameters:

• mode (str) – Split mode, one of copy, instance, or empty.

• window (int | None) – Optional 1-based source window number. When omitted, the current graphics window is split.

Return type:

WindowSplitResult

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_vertical(mode="copy")

fieldview.layout.split_horizontal(mode='copy', window=None)

Split a window horizontally and return metadata for the new window.

window=None targets the current window. The new window becomes current on success.

Parameters:

• mode (str) – Split mode, one of copy, instance, or empty.

• window (int | None) – Optional 1-based source window number. When omitted, the current graphics window is split.

Return type:

WindowSplitResult

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_horizontal(mode="copy")

fieldview.layout.get_view_sync(window=None)

Return whether a window propagates view/camera changes to synced panes.

window=None targets the current window.

Parameters:

window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

bool

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> enabled = fv.layout.get_view_sync()

fieldview.layout.set_view_sync(enabled, window=None)

Enable or disable multi-window view syncing for a graphics window.

window=None targets the current window.

Parameters:

• enabled (bool) – Whether view/camera synchronization should be enabled for the target window.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_vertical(mode="copy")
>>> fv.layout.set_view_sync(True, window=split.source_window)
>>> fv.layout.set_view_sync(True, window=split.new_window)

fieldview.layout.close(window=None)

Close a graphics window.

window=None closes the current window. When the current child window is closed, FieldView selects its parent window.

Parameters:

window (int | None) – Optional 1-based window number to close. When omitted, the current graphics window is closed.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> split = fv.layout.split_vertical(mode="copy")
>>> fv.layout.close(split.new_window)

View

fieldview.view

View-control helpers for interactive or batch FieldView sessions.

By default the functions in this module operate on the current graphics window. Use window= to target a specific 1-based window number.

This module is responsible for coarse view operations such as centering, fitting, cardinal or isometric alignment, and perspective or overlay toggles. Use it together with fieldview.layout for pane selection and fieldview.camera for lower-level navigation and camera-state control.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> fv.view.align("+z")

fieldview.view.center(x=None, y=None, z=None, *, window=None)

Center the view.

With no coordinates, centers automatically on the current scene contents. With x, y, and z provided, translates the current view so the specified world-space point appears at the window center. This operation preserves the current viewing orientation and camera offset, so both eye and target may move together. window=None targets the current window.

Parameters:

• x (float | None) – X coordinate of the world-space point to place at the screen center. Provide all of x, y, and z together, or omit all three for automatic centering.

• y (float | None) – Y coordinate of the world-space point to place at the screen center.

• z (float | None) – Z coordinate of the world-space point to place at the screen center.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.center()
>>> fv.view.center(0.0, 0.0, 0.0)

fieldview.view.fit(*, window=None)

Fit the current scene contents to the view.

window=None targets the current window.

Parameters:

window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()

fieldview.view.reset(*, window=None)

Reset world transforms for the selected window.

This matches the UI reset action for the world transform. window=None targets the current window.

Parameters:

window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.reset()

fieldview.view.align(direction, *, window=None)

Align the view to a cardinal or isometric direction.

window=None targets the current window.

Parameters:

• direction (str | Sequence[str]) – Either one of +x, -x, +y, -y, +z, -z for a cardinal view, or a sequence of three such strings for an isometric orientation.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.align("+x")
>>> fv.view.align(("+x", "+y", "+z"))

fieldview.view.set_perspective(enabled, angle=None, *, window=None)

Enable or disable perspective for a window.

window=None targets the current window.

Parameters:

• enabled (bool) – Whether perspective projection should be enabled.

• angle (float | None) – Optional perspective angle in degrees. When omitted, the host keeps the current perspective angle.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.set_perspective(True, angle=30.0)

fieldview.view.get_perspective(*, window=None)

Return the current perspective state for a window.

window=None targets the current window.

Parameters:

window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

PerspectiveState

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.set_perspective(True, angle=30.0)
>>> state = fv.view.get_perspective()

fieldview.view.set_outline(enabled)

Enable or disable dataset outlines for the current scene.

Parameters:

enabled (bool) – Whether dataset outlines should be visible.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.set_outline(True)

fieldview.view.get_outline()

Return whether dataset outlines are currently visible.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> visible = fv.view.get_outline()

Return type:

bool

fieldview.view.set_axis_markers(enabled)

Enable or disable the global axis-marker overlay.

Parameters:

enabled (bool) – Whether the global axis-marker overlay should be visible.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.set_axis_markers(True)

fieldview.view.get_axis_markers()

Return whether the global axis-marker overlay is visible.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> visible = fv.view.get_axis_markers()

Return type:

bool

Camera

fieldview.camera

Direct camera/navigation helpers for interactive or batch FieldView sessions.

The fieldview.camera module complements fieldview.view:

• fieldview.view handles coarse view operations such as fit, center, and perspective enable/disable.

• fieldview.camera handles direct navigation and deterministic camera capture/restore.

All functions default to the current graphics window and accept window= when a specific pane must be targeted directly.

Use this module when automation needs reproducible camera moves, explicit camera targeting, or save-and-restore behavior across multiple layout panes.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> fv.camera.orbit(15.0, -10.0)

fieldview.camera.pan(dx, dy, *, window=None)

Translate the camera laterally in screen/view space.

Positive dx moves right. Positive dy moves upward. The target and eye move together, so the viewing direction is preserved.

Parameters:

• dx (float) – Horizontal screen-space pan amount.

• dy (float) – Vertical screen-space pan amount.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.pan(0.1, 0.05)

fieldview.camera.zoom(factor, *, window=None)

Adjust the current zoom or perspective magnification by a factor.

factor must be greater than zero. Values larger than 1 zoom in and values between 0 and 1 zoom out.

Parameters:

• factor (float) – Multiplicative zoom factor. Values greater than 1 zoom in; values between 0 and 1 zoom out.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.zoom(1.2)

fieldview.camera.dolly(distance, *, window=None)

Move the camera forward or backward along its current view direction.

Positive values move the camera closer to the current target. Negative values move it farther away.

Parameters:

• distance (float) – Signed distance to move along the current view direction. Positive values move toward the target; negative values move away.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.dolly(0.5)

fieldview.camera.rotate(yaw, pitch, roll=0.0, *, window=None)

Rotate the camera orientation using yaw, pitch, and optional roll.

yaw rotates about the current up axis, pitch rotates about the current right axis, and roll rotates about the current forward axis.

Parameters:

• yaw (float) – Rotation in degrees about the current up axis.

• pitch (float) – Rotation in degrees about the current right axis.

• roll (float) – Rotation in degrees about the current forward axis.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.rotate(10.0, -5.0, 0.0)

fieldview.camera.orbit(dx, dy, *, window=None)

Convenience wrapper around rotate() for orbit-style navigation.

dx is the yaw rotation in degrees about the current up axis. dy is the pitch rotation in degrees about the current right axis.

This is equivalent to rotate(dx, dy, 0.0, window=window).

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.orbit(15.0, -10.0)

Parameters:

• dx (float)

• dy (float)

• window (int | None)

Return type:

None

fieldview.camera.look_at(target, eye=None, up=None, *, window=None)

Aim the camera at a target, with optional explicit eye and up vectors.

When eye or up is omitted, the current value for that component is used as the input to the look-at solve. The resulting camera frame is orthonormalized by the host, so the final up direction may be adjusted to remain perpendicular to the final view direction.

Parameters:

• target (object) – Three-number target position to look at.

• eye (object) – Optional three-number camera position. When omitted, the current eye position is reused as the look-at input.

• up (object) – Optional three-number up vector. When omitted, the current up vector is reused as the look-at input and may be adjusted to produce a valid orientation.

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.camera.look_at((0.0, 0.0, 0.0))

fieldview.camera.get_state(*, window=None)

Capture the current deterministic view state for exact reuse.

Parameters:

window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

ViewState

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> state = fv.camera.get_state()

fieldview.camera.set_state(state, *, window=None)

Restore a deterministic view state previously returned by get_state().

Parameters:

• state (ViewState) – Deterministic view state object previously returned by get_state().

• window (int | None) – Optional 1-based window number. When omitted, the current graphics window is used.

Return type:

None

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> state = fv.camera.get_state()
>>> fv.camera.orbit(20.0, -10.0)
>>> fv.camera.set_state(state)

Export

fieldview.export

Image export helpers for rendered FieldView output.

The fieldview.export namespace provides thin wrappers around FieldView’s host-side image export commands. These functions are intended for automation workflows that need to capture the current graphics view to PNG, JPG, BMP, or other supported image formats.

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> request_id = fv.export_png("/tmp/f18.png")

fieldview.export.export_image(path, format='png', source='graphics', render_sync=True)

Export an image through FieldView.

Parameters:

• path (str | PathLike[str]) – Output file path.

• format (str) – Image format name (e.g., “png”, “jpg”, “bmp”).

• source (str) – Render source; defaults to “graphics”.

• render_sync (bool) – Whether to block until render completes.

Returns:

Request id from the dispatcher.

Return type:

str

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> request_id = fv.export_image("/tmp/f18.jpg", format="jpg")

fieldview.export.export_png(path, source='graphics', render_sync=True)

Export a PNG image.

Parameters:

• path (str | PathLike[str]) – Output file path.

• source (str) – Render source; defaults to “graphics”.

• render_sync (bool) – Whether to block until render completes.

Returns:

Request id from the dispatcher.

Return type:

str

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> request_id = fv.export_png("/tmp/f18.png")

fieldview.export.export_jpg(path, source='graphics', render_sync=True)

Export a JPG image.

Parameters:

• path (str | PathLike[str]) – Output file path.

• source (str) – Render source; defaults to “graphics”.

• render_sync (bool) – Whether to block until render completes.

Returns:

Request id from the dispatcher.

Return type:

str

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> request_id = fv.export_jpg("/tmp/f18.jpg")

fieldview.export.export_bmp(path, source='graphics', render_sync=True)

Export a BMP image.

Parameters:

• path (str | PathLike[str]) – Output file path.

• source (str) – Render source; defaults to “graphics”.

• render_sync (bool) – Whether to block until render completes.

Returns:

Request id from the dispatcher.

Return type:

str

Example:

>>> import os
>>> import fieldview as fv
>>> data_dir = os.path.join(fv.home, "examples", "f18")
>>> ds = fv.data.load_plot3d(
...     os.path.join(data_dir, "f18i9b_g_bin"),
...     os.path.join(data_dir, "f18i9b_q_bin"),
... )
>>> fv.view.fit()
>>> request_id = fv.export_bmp("/tmp/f18.bmp")

Utilities

Shared enums and helpers for the FieldView Python package.

class fieldview.utils.Colormap

Scalar colormap options.

copy()

Return a detached copy of the options.

Return type:

Colormap

filled_contour: bool | None = None

Toggle filled contours.

invert: bool | None = None

Toggle inverted colormap.

max: float | None = None

Scalar maximum.

min: float | None = None

Scalar minimum.

name: ColormapName | str | None = None

constant.ColormapName or user map filename.

num_contours: int | None = None

Contour count (2-500).

property range: Range | None

Get or set the scalar min/max as a Range, if both are set.

unify_map()

Unify the colormap across coordinate surfaces.

Return type:

None

use_local: bool | None = None

Toggle local scalar min/max.

class fieldview.utils.VectorOptions

Vector display options.

animate: bool | None = None

Toggle curved vector animation.

copy()

Return a detached copy of the options.

Return type:

VectorOptions

display_type: CurvedVectorDisplayType | str | None = None

Curved vector display type (complete/filament/growing).

head_scaling: bool | None = None

Toggle head scaling.

head_scaling_value: float | None = None

Head scaling factor.

head_type: VectorHeadType | str | None = None

2D or 3D heads.

r_samples: int | None = None

Uniform sampling count for R (cylindrical).

shaft_type: VectorShaftType | str | None = None

Straight or curved shafts.

skip: bool | None = None

Toggle vector skipping.

skip_value: float | None = None

Skip fraction (0.0-1.0).

t_samples: int | None = None

Uniform sampling count for T (cylindrical).

time_limit: float | None = None

Curved vector integration time limit.

type: VectorProjectionType | str | None = None

Vector projection type (total/yz/xz/xy/projected).

uniform_sampling: bool | None = None

Toggle uniform sampling grid.

vector_scale: float | None = None

Shaft length scale.

x_samples: int | None = None

Uniform sampling count for X.

y_samples: int | None = None

Uniform sampling count for Y.

z_samples: int | None = None

Uniform sampling count for Z.

class fieldview.utils.Legend

Legend options.

annotation: LegendAnnotation | None = None

LegendAnnotation.

background: bool | None = None

Toggle legend background.

contour: LegendContour | None = None

LegendContour.

copy()

Return a detached copy of the options.

Return type:

Legend

frame: bool | None = None

Toggle legend frame.

labels: LegendLabels | None = None

LegendLabels.

relative_position: tuple[float, float] | None = None

Relative legend position as (x, y) in NDC.

scale_height: float | None = None

Height scale (1.0 is natural height).

scale_width: float | None = None

Width scale (1.0 is natural width).

show: bool | None = None

Toggle legend visibility.

spectrum: LegendSpectrum | None = None

LegendSpectrum.

type: LegendType | str | None = None

constant.LegendType (spectrum/contour).

class fieldview.utils.ScalarMinMax

Scalar min/max annotation options.

copy()

Return a detached copy of the options.

Return type:

ScalarMinMax

font: Font | str | None = None

get_max_position()

Return XYZ position for the current scalar maximum.

Return type:

tuple[float, float, float]

get_max_value()

Return the current scalar maximum value.

Return type:

float

get_min_position()

Return XYZ position for the current scalar minimum.

Return type:

tuple[float, float, float]

get_min_value()

Return the current scalar minimum value.

Return type:

float

get_minmax_positions()

Return XYZ positions for scalar min/max values.

Return type:

tuple[tuple[float, float, float], tuple[float, float, float]]

get_minmax_values()

Return the current scalar min/max values.

Return type:

tuple[float, float]

max: ScalarAnnotation | None = None

min: ScalarAnnotation | None = None

show: bool = False

size: int | None = None

class fieldview.utils.RangedValue

Range plus selected value.

property range: Range

property value: int | float | None

class fieldview.utils.Range

Generic numeric range container.

property abs_max: int | float | None

property abs_min: int | float | None

property max: int | float | None

property min: int | float | None

Constants

Enum constants for the FieldView Python package.

class fieldview.constant.AnimationDirection

Streamline animation direction.

• FORWARD

• BACKWARD

class fieldview.constant.AnnotationArrowPoint

Annotation arrow endpoint key.

• TIP

• TAIL

class fieldview.constant.AnnotationTextAlign

Annotation text alignment.

• LEFT

• TOP

• CENTER

• MIDDLE

• RIGHT

• BOTTOM

class fieldview.constant.AnnotationTextDirection

Annotation text direction.

• HORIZONTAL

• VERTICAL

class fieldview.constant.Axes

Axis combinations for mirror/translate operations.

• X

• Y

• Z

• XY

• XZ

• YZ

• XYZ

class fieldview.constant.Axis

Single-axis identifier (x/y/z).

• X

• Y

• Z

class fieldview.constant.BoundaryTypeSelection

Boundary type selection keywords.

• ALL

• NONE

class fieldview.constant.CalculationDirection

Streamline calculation direction.

• FORWARD

• BACKWARD

• BOTH

class fieldview.constant.Coloring

Surface coloring mode identifier.

• GEOMETRIC

• SCALAR

• MATERIAL

class fieldview.constant.ColormapName

Colormap name identifiers.

• SPECTRUM

• NASA_1

• NASA_2

• GRAY_SCALE

• COLOR_STRIPED

• BLACK_AND_WHITE

• STRIPED

• ZEBRA

• ACHROMATIC_VISION_1

• ACHROMATIC_VISION_2

• BANDED_BLUE_TO_RED_DARK

• BANDED_BLUE_TO_RED_LIGHT

• BANDED_GRAYSCALE

• BIG_DIFFERENCE

• BIO_SPECTRUM_1

• BIO_SPECTRUM_2

• BLOODFLOW_DOPPLER

• BLUE_CHROME

• CAMOUFLAGE

• CCM_BLUE_RED

• CCM_COOL_WARM

• CCM_HIGH_CONTRAST

• CCM_SPECTRUM

• CD_SPECTRUM

• CD_STRIPED

• CHROME

• COLD

• DARK_RADIATION

• DARK_SPECTRUM

• DARK_GREEN_GRADIENT

• FLAME_TRANSITION

• GOLD

• HIGH_CONTRAST

• HOT

• HOT_TO_COLD_DIFF

• INDIGO_FLAME

• LEAF_COLOR

• RADIATION_COLORS

• RED_TO_BLUE_DIFF

• RED_TO_PURPLE_DIFF

• RELIEF_MAP

• RELIEF_MAP_LAND

• RELIEF_MAP_OCEAN

• SIMPLE_FLUX

• SMALL_DIFFERENCE

• SPECTRUM_DIFF_GRAY

• SPECTRUM_DIFF_WHITE

• STEEL_BLUE

• TEAL_BLACK_GRADIENT

• INFERNO

• MAGMA

• PLASMA

• VIRIDIS

class fieldview.constant.ContourColoring

Contour coloring identifier.

• NONE

• BLACK

• WHITE

• GEOMETRIC

• SCALAR

class fieldview.constant.CurvedVectorDisplayType

Curved vector display type identifier.

• COMPLETE: Complete display.

• FILAMENT: Filament display.

• GROWING: Growing display.

class fieldview.constant.DisplayType

Surface display type identifier.

• CONSTANT: Constant shading.

• FACETED: Faceted shading.

• SMOOTH: Smooth shading.

• MESH: Mesh display.

• CONTOURS: Contour lines.

• CRINKLE: Crinkle display.

• VERTICES: Unlit vertices.

• SHADED_VERTICES: Lit vertices.

• VECTORS: Vector display mode.

class fieldview.constant.DuplicateOperation

Duplicate operation to apply to the dataset.

• NONE

• MIRROR

• ROTATE

• TRANSLATE

class fieldview.constant.Font

Text font identifier.

• LEE

• LEE_BOLD

• LEE_ITALIC

• LEE_BOLD_ITALIC

• LEEMONO

• LEEMONO_BOLD

• LEEMONO_ITALIC

• LEEMONO_BOLD_ITALIC

• LEESE

• LEESE_BOLD

• NOTO

• NOTO_SANS_REGULAR

• ROMAN_SANS_SERIF

• ROMAN

• ITALICS

• SCRIPT

class fieldview.constant.GeometricColor

FV geometric color ids (1-10).

• BLACK

• WHITE

• RED

• GREEN

• BLUE

• CYAN

• MAGENTA

• YELLOW

• PURPLE

• GRAY

class fieldview.constant.GridProcessing

Balance between preprocessing cost and load speed.

• LESS

• BALANCED

• MORE

class fieldview.constant.InputMode

How new loads interact with existing datasets.

REPLACE replaces the current dataset; previously returned Dataset objects become invalid.

• REPLACE

• APPEND

class fieldview.constant.LegendAnnotationPosition

Legend annotation relative position.

• LEFT

• RIGHT

• TOP

• BOTTOM

class fieldview.constant.LegendLabelsColorMode

Legend labels color mode.

• GEOMETRIC

• SCALAR

class fieldview.constant.LegendLabelsPerLine

Contour legend labels-per-line.

• SINGLE

• MULTI

class fieldview.constant.LegendType

Legend type identifier.

• SPECTRUM

• CONTOUR

class fieldview.constant.LineType

Line type identifier.

• THIN

• MEDIUM

• THICK

class fieldview.constant.Material

Boundary material preset names.

• ALUMINUM

• BRASS

• BRONZE

• CHROME

• COPPER

• GOLD

• IRON

• SILVER

• STEEL

• TITANIUM

• GLOSSY_PAINT

• MATTE_PAINT

• SHINY_PLASTIC

• DULL_PLASTIC

• GLASS

• RUBBER

class fieldview.constant.NumericalFormat

Numerical format identifier.

• FLOATING_POINT

• EXPONENTIAL

• POWERS_OF_TEN

class fieldview.constant.PathsDisplayType

Streamline display type identifier.

• COMPLETE

• FILAMENT

• FILAMENT_ARROWS

• FILAMENT_SPHERES

• GROWING

• SPHERES_AND_LINES

• SPHERES

• POLYSPHERES

• DOTS

• LINES_OF_SPHERES

• LINES_OF_DOTS

• RIBBONS

class fieldview.constant.Plane

Single-axis identifier (x/y/z/r/t/i/j/k).

• X

• Y

• Z

• R

• T

• I

• J

• K

class fieldview.constant.Plot2DBorderLayout

2D plot border layout.

• ALL_SIDES

• ACTIVE_AXES

class fieldview.constant.Plot2DHorizontalAxis

2D plot horizontal axis mode.

• DISTANCE

• X

• Y

• Z

• R

• T

class fieldview.constant.Plot2DLineStyle

2D plot line style.

• SOLID

• DASHED

class fieldview.constant.Plot2DPathKind

2D plot path kind.

• VOLUME_LINE

• IMPORTED

class fieldview.constant.Plot2DPathStyle

2D plot path drawing style.

• LINES

• SYMBOLS

• LINES_AND_SYMBOLS

class fieldview.constant.Plot2DSamplingMode

2D plot path sampling mode.

• CELL_CROSSINGS

• UNIFORM

class fieldview.constant.Plot3dCoords

Coordinate dimensionality for Plot3D inputs.

• D2

• D3

class fieldview.constant.Plot3dFileFormat

Explicit Plot3D file format when auto-detect is disabled.

• FORMATTED

• UNFORMATTED

• DP_UNFORMATTED

• BINARY

class fieldview.constant.Scale

Colormap scale.

• LINEAR

• LOG

class fieldview.constant.ServerConfig

Server configuration selector.

Use LOCAL/LOCAL_PARALLEL or pass a configuration name string (without the .srv extension) found under the sconfig folder.

• LOCAL

• LOCAL_PARALLEL

class fieldview.constant.ServerType

Execution mode for dataset operations.

• STANDARD

• SHMEM

• P4

class fieldview.constant.StreamlinesSeedCoord

Streamline seed coordinate type.

• IJK

• IJK_REAL

• XYZ

class fieldview.constant.SurfaceFlowMode

Surface flow calculation mode.

• NO_SLIP

• EULER

• OFFSET

class fieldview.constant.SurfaceFlowSeeding

Surface flow seeding mode.

• LOW_DENSITY

• MEDIUM_DENSITY

• HIGH_DENSITY

• FROM_FILE

class fieldview.constant.SweepDirection

Sweep direction identifier.

• UP

• DOWN

• BOUNCE

class fieldview.constant.VectorHeadType

Vector head type identifier.

• HEAD2D: 2D heads.

• HEAD3D: 3D heads.

class fieldview.constant.VectorProjectionType

Vector projection type identifier.

• TOTAL: Total vector.

• YZ: Project to YZ.

• XZ: Project to XZ.

• XY: Project to XY.

• PROJECTED: Projected vector.

class fieldview.constant.VectorShaftType

Vector shaft type identifier.

• STRAIGHT: Straight shafts.

• CURVED: Curved shafts.

class fieldview.constant.VortexCoreMethod

Vortex core detection method.

• VORTICITY_ALIGNMENT

• EIGENMODE_ANALYSIS

Exceptions

FieldView-specific exception hierarchy.

exception fieldview.exceptions.CoreError

Core/engine call failed.

exception fieldview.exceptions.FieldViewError

Base error for the FieldView Python API.

exception fieldview.exceptions.InvalidArgumentError

Invalid argument or value supplied.

exception fieldview.exceptions.InvalidDatasetError

Dataset is invalid, missing, or not loaded.