API Reference [update in progress]

platerecipy.io

File brief

io.py

Module for input/output functions.

This is a part of platerecipy package. For license and citation, please refer to the main repository: github.com/pjavaheri/platerecipy

Author(s): Pejvak Javaheri; pejvak.javaheri@mail.utoronto.ca

save_as_csv(model, other_fields=None, other_fields_names=None, map_to_original=False, filename='platerecipy_output.csv')

To save the interpolated model as a CSV file.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
other_fields	(list, optional)	A list of additional fields to be included in the output.	None
other_fields_names	(list, optional)	A list of field identifiers corresponding to other_fields.	None
map_to_original	bool	Whether to map the fields back to the original input data points.	False
filename	str	Output filename.	'platerecipy_output.csv'

save_as_mat(model, other_fields=None, other_fields_names=None, filename='platerecipy_output.mat')

To save the interpolated model as OCTAVE/MATLAB file.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
other_fields	(list, optional)	A list of additional fields to be included in the output.	None
other_fields_names	(list, optional)	A list of field identifiers corresponding to other_fields.	None
filename	str	Output filename.	'platerecipy_output.mat'

save_as_vtk(model, other_fields=None, other_fields_names=None, filename='platerecipy_output.vtk')

To save the interpolated model as VTK ParaView-readable file.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
other_fields	(list, optional)	A list of additional fields to be included in the output.	None
other_fields_names	(list, optional)	A list of field identifiers corresponding to other_fields.	None
filename	str	Output filename.	'platerecipy_output.vtk'

Returns:

Type	Description
`None`

save_as_vtp(model, other_fields=None, other_fields_names=None, filename='platerecipy_output.vtp', return_mesh=False)

To save the interpolated model as VTP ParaView file.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
other_fields	(list, optional)	A list of additional fields to be included in the output.	None
other_fields_names	(list, optional)	A list of field identifiers corresponding to other_fields.	None
filename	str	Output filename.	'platerecipy_output.vtp'
return_mesh	bool	Whether to also return the pyvista mesh created.	False,

Returns:

Type	Description
`None` or a `pyvista` mesh

save_mollweide_projection(model, filename='platerecipy_mollweide_output.png')

To save the model as a Mollweide projection.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
filename	str	Output filename.	'platerecipy_mollweide_output.png'

save_six_view_angles(model, filename='platerecipy_six_angle_output.png')

To save the model viewed in six angles.

Parameters:

Name	Type	Description	Default
model	(PlateModel,)	An input model whose plates are identified.	required
filename	str	Output filename.	'platerecipy_six_angle_output.png'