export_landmark_file¶
-
menpo.io.
export_landmark_file
(landmarks_object, fp, extension=None, overwrite=False)[source]¶ Exports a given shape. The
fp
argument can be either or a str or any Python type that acts like a file. If a file is provided, theextension
kwarg must be provided. If noextension
is provided and a str filepath is provided, then the export type is calculated based on the filepath extension.Due to the mix in string and file types, an explicit overwrite argument is used which is
False
by default.- Parameters
landmarks_object (dict or
LandmarkManager
or) –PointCloud
or subclass ofPointCloud
The landmarks to export. The type ofPointCloud
or subclass of it are supported by all exporters, while the rest are available only for the LJSON format.fp (Path or file-like object) – The Path or file-like object to save the object at/into.
extension (str or None, optional) – The extension to use, this must match the file path if the file path is a string. Determines the type of exporter that is used.
overwrite (bool, optional) – Whether or not to overwrite a file if it already exists.
- Raises
ValueError – File already exists and
overwrite
!=True
ValueError –
fp
is a str and theextension
is notNone
and the two extensions do not matchValueError –
fp
is a file-like object andextension
isNone
ValueError – The provided extension does not match to an existing exporter type (the output type is not supported).
ValueError – The provided type for landmarks_object is not supported.