DGtal  0.9.4beta
Public Types | Public Member Functions | Private Member Functions | Private Attributes | Friends
DGtal::SignedKhalimskyCell< dim, TInteger > Struct Template Reference

#include <DGtal/topology/KhalimskySpaceND.h>

Collaboration diagram for DGtal::SignedKhalimskyCell< dim, TInteger >:
[legend]

Public Types

using Integer = TInteger
 
using UnsignedInteger = typename NumberTraits< Integer >::UnsignedVersion
 
using Point = PointVector< dim, Integer >
 
using SPreCell = SignedKhalimskyPreCell< dim, Integer >
 
using CellularGridSpace = KhalimskySpaceND< dim, TInteger >
 
using PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >
 
using Self = SignedKhalimskyCell< dim, Integer >
 

Public Member Functions

 BOOST_CONCEPT_ASSERT ((concepts::CInteger< TInteger >))
 
 operator SPreCell const & () const
 
SPreCell const & preCell () const
 
 SignedKhalimskyCell (Integer dummy=0)
 
 SignedKhalimskyCell (const SignedKhalimskyCell &other)=default
 
SignedKhalimskyCelloperator= (const SignedKhalimskyCell &other)=default
 
 SignedKhalimskyCell (SignedKhalimskyCell &&other)=default
 
SignedKhalimskyCelloperator= (SignedKhalimskyCell &&other)=default
 
bool operator== (const SignedKhalimskyCell &other) const
 
bool operator!= (const SignedKhalimskyCell &other) const
 
bool operator< (const SignedKhalimskyCell &other) const
 
std::string className () const
 

Private Member Functions

 SignedKhalimskyCell (const Point &aPoint, bool positive)
 
 SignedKhalimskyCell (const SPreCell &aCell)
 
 operator SPreCell & ()
 

Private Attributes

SPreCell mySPreCell
 

Friends

class KhalimskySpaceND< dim, TInteger >
 
class KhalimskySpaceNDHelper< CellularGridSpace >
 

Detailed Description

template<Dimension dim, typename TInteger = DGtal::int32_t>
struct DGtal::SignedKhalimskyCell< dim, TInteger >

Represents a signed cell in a cellular grid space by its Khalimsky coordinates and a boolean value.

Template Parameters
dimthe dimension of the digital space.
TIntegerthe Integer class used to specify the arithmetic computations (default type = int32).
Examples:
dec/exampleDECSurface.cpp, io/viewers/viewer3D-10-interaction.cpp, topology/ctopo-1s-3d.cpp, topology/ctopo-2-3d.cpp, topology/ctopo-2.cpp, topology/ctopo-fillContours.cpp, and tutorial-examples/AreaSurfaceEstimation-final.cpp.

Definition at line 208 of file KhalimskySpaceND.h.

Member Typedef Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::CellularGridSpace = KhalimskySpaceND< dim, TInteger >

Definition at line 219 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::Integer = TInteger

Definition at line 215 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::Point = PointVector< dim, Integer >

Definition at line 217 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::PreCellularGridSpace = KhalimskyPreSpaceND< dim, TInteger >

Definition at line 220 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::Self = SignedKhalimskyCell< dim, Integer >

Definition at line 221 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::SPreCell = SignedKhalimskyPreCell< dim, Integer >

Definition at line 218 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
using DGtal::SignedKhalimskyCell< dim, TInteger >::UnsignedInteger = typename NumberTraits<Integer>::UnsignedVersion

Definition at line 216 of file KhalimskySpaceND.h.

Constructor & Destructor Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const Point aPoint,
bool  positive 
)
explicitprivate

Explicit constructor from its Khalimsky coordinates.

Parameters
aPointany point.
positiveif cell has positive sign.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const SPreCell aCell)
explicitprivate

² Explicit constructor from a SignedKhalimskyPreCell.

Parameters
aCella pre-cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( Integer  dummy = 0)
explicit

Default constructor.

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const SignedKhalimskyCell< dim, TInteger > &  other)
default

Copy constructor.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( SignedKhalimskyCell< dim, TInteger > &&  other)
default

Move constructor.

Parameters
otherany other cell.

Member Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< TInteger >)  )
template<Dimension dim, typename TInteger = DGtal::int32_t>
std::string DGtal::SignedKhalimskyCell< dim, TInteger >::className ( ) const

Default drawing style object.

Returns
the dyn. alloc. default style for this object.
the style name used for drawing this object.
Examples:
io/viewers/viewer3D-10-interaction.cpp.
template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::operator SPreCell & ( )
explicitprivate

Mutable conversion to KhalimskySignedPreCell.

template<Dimension dim, typename TInteger = DGtal::int32_t>
DGtal::SignedKhalimskyCell< dim, TInteger >::operator SPreCell const & ( ) const

Constant conversion to KhalimskySignedPreCell.

template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator!= ( const SignedKhalimskyCell< dim, TInteger > &  other) const

Difference operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator< ( const SignedKhalimskyCell< dim, TInteger > &  other) const

Inferior operator. (lexicographic order).

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
SignedKhalimskyCell& DGtal::SignedKhalimskyCell< dim, TInteger >::operator= ( const SignedKhalimskyCell< dim, TInteger > &  other)
default

Copy operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
SignedKhalimskyCell& DGtal::SignedKhalimskyCell< dim, TInteger >::operator= ( SignedKhalimskyCell< dim, TInteger > &&  other)
default

Move operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator== ( const SignedKhalimskyCell< dim, TInteger > &  other) const

Equality operator.

Parameters
otherany other cell.
template<Dimension dim, typename TInteger = DGtal::int32_t>
SPreCell const& DGtal::SignedKhalimskyCell< dim, TInteger >::preCell ( ) const

Friends And Related Function Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
friend class KhalimskySpaceND< dim, TInteger >
friend

Definition at line 224 of file KhalimskySpaceND.h.

template<Dimension dim, typename TInteger = DGtal::int32_t>
friend class KhalimskySpaceNDHelper< CellularGridSpace >
friend

Definition at line 225 of file KhalimskySpaceND.h.

Field Documentation

template<Dimension dim, typename TInteger = DGtal::int32_t>
SPreCell DGtal::SignedKhalimskyCell< dim, TInteger >::mySPreCell
private

Definition at line 229 of file KhalimskySpaceND.h.


The documentation for this struct was generated from the following file: