CGAL 6.3-dev - Homological Discrete Vector Fields
Loading...
Searching...
No Matches

Classes

class  CGAL::Homological_discrete_vector_field::Cub_object_io< Traits >
 The class Cub_object_io is an intermediate IO class, used to load binary volumes and produce cubical complexes. More...
class  CGAL::Homological_discrete_vector_field::Icosphere_object_io< Traits >
 The class Icosphere_object_io is an intermediate IO class, used to produce a Mesh_object_io containing an icosphere (for Hdvf_duality with tetgen). More...
class  CGAL::Homological_discrete_vector_field::Mesh_object_io< Traits >
 The class Mesh_object_io is an intermediate IO class, used to load and create arbitrary collections of simplices, that is collections without a priori structures, unlike simplicial complexes (closed under the face operation), proper meshes (including only cells of maximal dimension) or manifolds. More...
class  CGAL::Homological_discrete_vector_field::Surface_mesh_io< TriangleMesh, Traits >
 The class Surface_mesh_io is an intermediate IO class, used to load the collection of simplices of a triangle mesh. More...
class  CGAL::Homological_discrete_vector_field::Tet_object_io< Traits >
 The class Tet_object_io is an intermediate IO class, used to load a tetgen triangulation (for Hdvf_duality) into a Mesh_object_io structure. More...
class  CGAL::Homological_discrete_vector_field::Triangulation_3_io< Triangulation3, Traits >
 The class Triangulation_3_io is an intermediate IO class, used to load a Triangulation_3 and produce simplicial complexes. More...

Functions

template<typename ChainComplex, typename VertexIdType = size_t>
void CGAL::IO::write_VTK (const Homological_discrete_vector_field::Hdvf_core< ChainComplex > &hdvf, const ChainComplex &complex, std::string filename="test", bool co_faces=false)
 Exports all the Hdvf information of a geometric chain complex to VTK files.
template<typename ChainComplex, typename Degree, typename FiltrationType>
void CGAL::IO::write_VTK (const Homological_discrete_vector_field::Hdvf_persistence< ChainComplex, Degree, FiltrationType > &per_hdvf, const ChainComplex &complex, std::string filename="per", bool co_faces=false)
 Exports all the HDVF_persistence information of a geometric chain complex to VTK files.
template<typename ChainComplex, typename VertexIdType = size_t>
void CGAL::IO::write_VTK (const Homological_discrete_vector_field::Hdvf_duality< ChainComplex > &hdvf, const ChainComplex &complex, std::string filename="test", bool co_faces=false)
 Exports all the HDVF_duality information of a geometric chain complex to VTK files.
template<typename Chain_complex, typename LabelType = int>
static void CGAL::IO::write_VTK (const Chain_complex &K, const std::string &filename, const std::vector< std::vector< LabelType > > *labels=NULL, std::string label_type_name="int")
 Exports a model of GeometricChainComplex (plus, optionally, labels) to a VTK file.
template<typename Chain_complex>
void CGAL::IO::write_VTK (const Chain_complex &K, const std::string &filename, const OSM::Sparse_chain< typename Chain_complex::Coefficient_ring, OSM::COLUMN > &chain, int q, size_t cellId=-1)
 Exports a chain over a model of GeometricChainComplex to a VTK file.

Function Documentation

◆ write_VTK() [1/5]

template<typename Chain_complex>
void CGAL::IO::write_VTK ( const Chain_complex & K,
const std::string & filename,
const OSM::Sparse_chain< typename Chain_complex::Coefficient_ring, OSM::COLUMN > & chain,
int q,
size_t cellId = -1 )

#include <CGAL/HDVF/Geometric_chain_complex_tools.h>

Exports a chain over a model of GeometricChainComplex to a VTK file.

The method generates legacy text VTK files. All the cells of the chain with non zero coefficient are exported. If a cellId is provided, labels are exported in a VTK property (2 for all cells, 0 for cell of index cellId). The index of each cell is exported in a CellID property.

Parameters
KModel of GeometricChainComplex exported.
filenameOutput file root (output filenames will be built from this root).
chainSparse_chain exported (all the cells with non-zero coefficients in the chain are exported to vtk).
qDimension of the cells of the chain.
cellIdIf different from MAX_SIZE_T, labels are exported to distinguish cells of the chain (label 2) from cellId cell (label 0).

◆ write_VTK() [2/5]

template<typename Chain_complex, typename LabelType = int>
void CGAL::IO::write_VTK ( const Chain_complex & K,
const std::string & filename,
const std::vector< std::vector< LabelType > > * labels = NULL,
std::string label_type_name = "int" )
static

#include <CGAL/HDVF/Geometric_chain_complex_tools.h>

Exports a model of GeometricChainComplex (plus, optionally, labels) to a VTK file.

The method generates legacy text VTK files. Labels are exported as such in a VTK property, together with CellID property, containing the index of each cell.

Template Parameters
LabelTypeType of labels provided (default: int).
Parameters
KModel of GeometricChainComplex exported.
filenameOutput file root (output filenames will be built from this root).
labelsPointer to a vector of labels in each dimension. (*labels).at(q) is the set of integer labels of cells of dimension q. If labels is NULL, only CellID property is exported.
label_type_nameTypename used in vtk export (e.g. "int" or "unsigned_long", see VTK manual ).

◆ write_VTK() [3/5]

template<typename ChainComplex, typename VertexIdType = size_t>
void CGAL::IO::write_VTK ( const Homological_discrete_vector_field::Hdvf_core< ChainComplex > & hdvf,
const ChainComplex & complex,
std::string filename = "test",
bool co_faces = false )

#include <CGAL/HDVF/Geometric_chain_complex_tools.h>

Exports all the Hdvf information of a geometric chain complex to VTK files.

Export PSC labels and homology/cohomology generators (depending on HDVF options) associated to each critical cell to VTK files.

Parameters
hdvfReference to the HDVF exported.
complexUnderlying geometric chain complex.
filenamePrefix of all generated files.
co_facesExport the cohomology generator or its co-faces (sometimes more convenient for visualisation).

Below, a sample mesh with, (left) homology generators, (right) two examples of cohomology generators (corresponding generators/co-generators bear similar colours):

The same generators displayed through their co-faces:

All homology / cohomology generators:

◆ write_VTK() [4/5]

template<typename ChainComplex, typename VertexIdType = size_t>
void CGAL::IO::write_VTK ( const Homological_discrete_vector_field::Hdvf_duality< ChainComplex > & hdvf,
const ChainComplex & complex,
std::string filename = "test",
bool co_faces = false )

#include <CGAL/HDVF/Geometric_chain_complex_tools.h>

Exports all the HDVF_duality information of a geometric chain complex to VTK files.

Export PSC labels and homology/cohomology generators (depending on HDVF options) associated to each persistent intervals to VTK files.

Parameters
hdvfReference to the HDVF exported.
complexUnderlying geometric chain complex.
filenamePrefix of all generated files.
co_facesExport the cohomology generator or its co-faces (sometimes more convenient for visualisation).

◆ write_VTK() [5/5]

template<typename ChainComplex, typename Degree, typename FiltrationType>
void CGAL::IO::write_VTK ( const Homological_discrete_vector_field::Hdvf_persistence< ChainComplex, Degree, FiltrationType > & per_hdvf,
const ChainComplex & complex,
std::string filename = "per",
bool co_faces = false )

#include <CGAL/HDVF/Geometric_chain_complex_tools.h>

Exports all the HDVF_persistence information of a geometric chain complex to VTK files.

Export PSC labels and homology/cohomology generators (depending on HDVF options) associated to each persistent intervals to VTK files.

Parameters
per_hdvfReference to the persistent HDVF exported.
complexUnderlying geometric chain complex.
filenamePrefix of all generated files.
co_facesExport the cohomology generator or its co-faces (sometimes more convenient for visualisation).