Create data for horizontal or vertical 2D slices

Attributes¶

algo: foxes.Algorithm

The algorithm for point calculation

farm_results: xarray.Dataset

The farm results

verbosity_delta: int

Verbosity threshold for printing calculation info

Public members¶

SliceData(algo, farm_results, verbosity_delta=1, **kwargs)[source]

Constructor.

get_mean_data_xy(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in a horizontal xy-plane.

get_mean_data_xz(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in an xz-plane.

get_mean_data_yz(resolution=None, n_img_points=None, ...)[source]

Creates mean data of 2D farm flow slices in a yz-plane.

get_states_data_xy(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in a horizontal xy-plane.

get_states_data_xz(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in an xz-plane.

get_states_data_yz(resolution=None, n_img_points=None, ...)[source]

Creates states data of 2D farm flow slices in a yz-plane.

get_fpath(fname)[source]

Gets the total file path

write(file_name, data, format_col2var={}, format_dict={}, **kwargs)[source]

Writes data to file via pandas.

classmethod print_models()[source]

Prints all model names.

classmethod new(output_type, *args, **kwargs)[source]

Run-time output model factory.