add_field_from_file

ModelPlotter.add_field_from_file(field_path, log_scale: bool = True, coordinate_units: str = 'meter', opacity: int = 1, color_map: str = 'jet', label_name: str = 'Field', surface_mapping_tolerance: float = 0.001, header_lines: int = 2, show_edges: bool = True) → None

Add a field file to the scenario.

It can be aedtplt, fld or csv file or any txt file with 4 column [x,y,z,field]. If text file they have to be space separated column.

Parameters:

field_pathstr

Full path to the file.

log_scalebool

Either if the field has to be plotted log or not.

coordinate_unitsstr

Fields coordinates units.

opacityfloat

Value between 0 to 1 of opacity.

color_mapstr

Color map of field plot. Default rainbow.

label_namestr, optional

Name of the field.

surface_mapping_tolerancefloat, optional

Delauny tolerance value used for interpolating points.

header_linesint

Number of lines to of the file containing header info that has to be removed.

Returns:

bool