Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 > Class Template Reference

Algorithm computing the surface area and the volume of the union of 3D balls. More...

#include <Union_of_balls_surface_volume_3.hpp>

Public Types

typedef T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 > Self
 
typedef UnionOfBallsBoundary3 Union_of_balls_boundary_3
 
typedef AlphaComplex3 Alpha_complex_3
 
typedef AlphaComplex3::Geom_traits::Kernel Input_kernel
 
typedef CGAL::Simple_cartesian< CGAL::Interval_nt< false > > Output_kernel
 
typedef Output_kernel::FT FT_output
 
typedef Input_kernel::FT FT_input
 
typedef AlphaComplex3::Vertex_handle Vertex_handle
 

Construction

 T_Union_of_balls_surface_volume_3 (UnionOfBallsBoundary3 &boundary)
 
 T_Union_of_balls_surface_volume_3 (AlphaComplex3 &alpha_complex)
 
template<class InputIterator >
 T_Union_of_balls_surface_volume_3 (InputIterator begin, InputIterator end, const FT_input &alpha=0.)
 
 ~T_Union_of_balls_surface_volume_3 (void)
 

Accessors

const AlphaComplex3 & get_alpha_complex (void) const
 
unsigned get_number_of_finite_vertices (void) const
 
const UnionOfBallsBoundary3 & get_boundary (void) const
 
UnionOfBallsBoundary3 & get_boundary (void)
 
FT_output volume (void) const
 
FT_output volume (unsigned i) const
 
FT_output volume (Vertex_handle v) const
 
FT_output area (void) const
 
FT_output area (Face_handle f) const
 
FT_output area (unsigned i) const
 
FT_output area (Vertex_handle v) const
 
FT_output area (const typename AlphaComplex3::Edge &e) const
 
bool is_buried (unsigned i) const
 
bool is_buried (Vertex_handle v) const
 

Cavities

unsigned get_number_of_cavities (void) const
 
FT_output get_area_of_cavity (unsigned i) const
 
FT_output get_volume_of_cavity (unsigned i) const
 

Detailed Description

template<class AlphaComplex3, class SphericalKernel3 = CGAL::Spherical_kernel_3<typename AlphaComplex3::Geom_traits::Kernel, CGAL::Algebraic_kernel_for_spheres_2_3<typename AlphaComplex3::FT> >, class UnionOfBallsBoundary3 = T_Union_of_balls_boundary_3_data_structure<AlphaComplex3>>
class SBL::GT::T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >

Algorithm computing the surface area and the volume of the union of 3D balls.

Algorithm computing the surface area and the volume of the union of 3D balls

Template Parameters
AlphaComplex3Alpha-complex of the input spheres
SphericalKernel3Geometric kernel for computations over a sphere
UnionOfBallsBoundary3Representation of the boundary of a union of spheres

Member Typedef Documentation

◆ Alpha_complex_3

typedef AlphaComplex3 Alpha_complex_3

◆ FT_input

typedef Input_kernel::FT FT_input

◆ FT_output

typedef Output_kernel::FT FT_output

◆ Input_kernel

typedef AlphaComplex3::Geom_traits::Kernel Input_kernel

◆ Output_kernel

typedef CGAL::Simple_cartesian<CGAL::Interval_nt<false> > Output_kernel

◆ Self

typedef T_Union_of_balls_surface_volume_3<AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3> Self

◆ Union_of_balls_boundary_3

typedef UnionOfBallsBoundary3 Union_of_balls_boundary_3

◆ Vertex_handle

typedef AlphaComplex3::Vertex_handle Vertex_handle

Constructor & Destructor Documentation

◆ T_Union_of_balls_surface_volume_3() [1/3]

T_Union_of_balls_surface_volume_3 ( UnionOfBallsBoundary3 &  boundary)
inline

◆ T_Union_of_balls_surface_volume_3() [2/3]

T_Union_of_balls_surface_volume_3 ( AlphaComplex3 &  alpha_complex)
inline

◆ T_Union_of_balls_surface_volume_3() [3/3]

T_Union_of_balls_surface_volume_3 ( InputIterator  begin,
InputIterator  end,
const FT_input alpha = 0. 
)
inline

◆ ~T_Union_of_balls_surface_volume_3()

Member Function Documentation

◆ area() [1/5]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output area ( const typename AlphaComplex3::Edge &  e) const
inline

◆ area() [2/5]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output area ( Face_handle  f) const
inline

◆ area() [3/5]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output area ( unsigned  i) const
inline

◆ area() [4/5]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output area ( Vertex_handle  v) const
inline

◆ area() [5/5]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output area ( void  ) const
inline

◆ get_alpha_complex()

const AlphaComplex3 & get_alpha_complex ( void  ) const
inline

◆ get_area_of_cavity()

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output get_area_of_cavity ( unsigned  i) const
inline

◆ get_boundary() [1/2]

UnionOfBallsBoundary3 & get_boundary ( void  )
inline

◆ get_boundary() [2/2]

const UnionOfBallsBoundary3 & get_boundary ( void  ) const
inline

◆ get_number_of_cavities()

unsigned get_number_of_cavities ( void  ) const
inline

◆ get_number_of_finite_vertices()

unsigned get_number_of_finite_vertices ( void  ) const
inline

◆ get_volume_of_cavity()

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output get_volume_of_cavity ( unsigned  i) const
inline

◆ is_buried() [1/2]

bool is_buried ( unsigned  i) const
inline

◆ is_buried() [2/2]

bool is_buried ( Vertex_handle  v) const
inline

◆ volume() [1/3]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output volume ( unsigned  i) const
inline

◆ volume() [2/3]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output volume ( Vertex_handle  v) const
inline

◆ volume() [3/3]

T_Union_of_balls_surface_volume_3< AlphaComplex3, SphericalKernel3, UnionOfBallsBoundary3 >::FT_output volume ( void  ) const
inline