read_size_field#

FileIO.read_size_field(file_name, params)#

Read PyPrimeMesh sizefield file from disk.

PyPrimeMesh sizefield files have psf and psf.gz extension.

Parameters:

file_namestr: Path to file on disk.
paramsReadSizeFieldParams: Parameters to read size field file.

Returns:

SizeFieldFileReadResults: Return the SizeFieldFileReadResults.

Return type:

SizeFieldFileReadResults

Notes

This API does not support Unicode paths now.

Examples

>>> file_io = prime.FileIO(model=model)
>>> params = prime.ReadSizeFieldParams(model=model)
>>> results = file_io.read_size_field("/tmp/my_prime_sizefield.psf", params)