add_field_from_file#
- ModelPlotter.add_field_from_file(field_path, log_scale=True, coordinate_units='meter', opacity=1, color_map='jet', label_name='Field', surface_mapping_tolerance=0.001, header_lines=2, show_edges=True)#
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_path
str
Full path to the file.
- log_scalebool
Either if the field has to be plotted log or not.
- coordinate_units
str
Fields coordinates units.
- opacity
float
Value between 0 to 1 of opacity.
- color_map
str
Color map of field plot. Default rainbow.
- label_name
str
,optional
Name of the field.
- surface_mapping_tolerance
float
,optional
Delauny tolerance value used for interpolating points.
- header_lines
int
Number of lines to of the file containing header info that has to be removed.
- field_path
- Returns: