se::io Namespace Reference

Functions
bool	has_supported_mesh_extension (const std::string &filename)
	Test whether the suffix of filename is one of the file extensions in se::io::mesh_extensions.
template<typename FaceT >
int	save_mesh (const Mesh< FaceT > &mesh_M, const std::string &filename, const Eigen::Affine3f &T_OM=Eigen::Affine3f::Identity())
	Save a mesh to a file whose type is determined by the extension of filename.
template<typename FaceT >
int	save_mesh_vtk (const Mesh< FaceT > &mesh_M, const std::string &filename, const Eigen::Affine3f &T_OM=Eigen::Affine3f::Identity())
	Save a mesh as a VTK file.
template<typename FaceT >
int	save_mesh_ply (const Mesh< FaceT > &mesh_M, const std::string &filename, const Eigen::Affine3f &T_OM=Eigen::Affine3f::Identity())
	Save a mesh as a PLY file.
template<typename FaceT >
int	save_mesh_obj (const Mesh< FaceT > &mesh_M, const std::string &filename, const Eigen::Affine3f &T_OM=Eigen::Affine3f::Identity())
	Save a mesh as an Wavefront OBJ file.
template<typename GetValueF >
bool	save_3d_slice_vtk (const std::string &filename, const Eigen::Vector3i &lower_coord, const Eigen::Vector3i &upper_coord, GetValueF &get_value)
	Generate a 3D slice of the octree.

Variables
static const std::array< std::string, 3 >	mesh_extensions = {".obj", ".ply", ".vtk"}
	The supported file extensions for mesh files.

Function Documentation

has_supported_mesh_extension()

bool se::io::has_supported_mesh_extension

(

const std::string &

filename

)

Test whether the suffix of filename is one of the file extensions in se::io::mesh_extensions.

save_mesh()

template<typename FaceT >

int se::io::save_mesh	(	const Mesh< FaceT > &	mesh_M,
		const std::string &	filename,
		const Eigen::Affine3f &	T_OM = Eigen::Affine3f::Identity()
	)

Save a mesh to a file whose type is determined by the extension of filename.

Exceptions

std::invalid_argument

Throws std::invalid_argument if a filename with an extension not contained in se::io::mesh_extensions is provided.

Parameters

[in]	mesh_M	The mesh to be saved expressed in some mesh frame M.
[in]	filename	The file where the mesh will be saved. Its extension must be one of those in se::io::mesh_extensions.
[in]	T_OM	The transformation from the mesh frame M to some output frame O. The transformation will be applied to each mesh vertex before saving it.

Returns

Zero on success, non-zero on error.

save_mesh_vtk()

template<typename FaceT >

int se::io::save_mesh_vtk	(	const Mesh< FaceT > &	mesh_M,
		const std::string &	filename,
		const Eigen::Affine3f &	T_OM = Eigen::Affine3f::Identity()
	)

Save a mesh as a VTK file.

The VTK file format is documented here: https://vtk.org/wp-content/uploads/2015/04/file-formats.pdf

Parameters

[in]	mesh_M	The mesh to be saved expressed in some mesh frame M.
[in]	filename	The file where the mesh will be saved.
[in]	T_OM	The transformation from the mesh frame M to some output frame O. The transformation will be applied to each mesh vertex before saving it.

Returns

Zero on success, non-zero on error.

save_mesh_ply()

template<typename FaceT >

int se::io::save_mesh_ply	(	const Mesh< FaceT > &	mesh_M,
		const std::string &	filename,
		const Eigen::Affine3f &	T_OM = Eigen::Affine3f::Identity()
	)

Save a mesh as a PLY file.

The PLY file format is documented here: http://paulbourke.net/dataformats/ply

Parameters

[in]	mesh_M	The mesh to be saved expressed in some mesh frame M.
[in]	filename	The file where the mesh will be saved.
[in]	T_OM	The transformation from the mesh frame M to some output frame O. The transformation will be applied to each mesh vertex before saving it.

Returns

Zero on success, non-zero on error.

save_mesh_obj()

template<typename FaceT >

int se::io::save_mesh_obj	(	const Mesh< FaceT > &	mesh_M,
		const std::string &	filename,
		const Eigen::Affine3f &	T_OM = Eigen::Affine3f::Identity()
	)

Save a mesh as an Wavefront OBJ file.

The Wavefront OBJ file format is documented here: http://fegemo.github.io/cefet-cg/attachments/obj-spec.pdf

Parameters

[in]	mesh_M	The mesh to be saved expressed in some mesh frame M.
[in]	filename	The file where the mesh will be saved.
[in]	T_OM	The transformation from the mesh frame M to some output frame O. The transformation will be applied to each mesh vertex before saving it.

Returns

Zero on success, non-zero on error.

save_3d_slice_vtk()

template<typename GetValueF >

bool se::io::save_3d_slice_vtk	(	const std::string &	filename,
		const Eigen::Vector3i &	lower_coord,
		const Eigen::Vector3i &	upper_coord,
		GetValueF &	get_value
	)

Generate a 3D slice of the octree.

Template Parameters

GetValueF

Parameters

filename	The file name to save the 3D slice to
lower_coord	The lower coords of the bounding box
upper_coord	The upper coords of the bounding box
get_value	The get value function (get_value(const Eigen::Vector3i)) extracting the value for given voxel coordinates

Returns

True if the file can be read, false otherwise

Variable Documentation

mesh_extensions

const std::array<std::string, 3> se::io::mesh_extensions = {".obj", ".ply", ".vtk"}

static

The supported file extensions for mesh files.