DGtal::SignedKhalimskyCell< dim, TInteger > Struct Template Reference

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

#include <DGtal/topology/KhalimskySpaceND.h>

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 >))
	Integer must be a model of the concept CInteger. More...
	operator SPreCell const & () const
	Constant conversion to SignedKhalimskyPreCell. More...
SPreCell const &	preCell () const
	Returns the underlying constant signed pre-cell. More...
	SignedKhalimskyCell (Integer dummy=0)
	Default constructor. More...
	SignedKhalimskyCell (const SignedKhalimskyCell &other)=default
	Copy constructor. More...
SignedKhalimskyCell &	operator= (const SignedKhalimskyCell &other)=default
	Copy operator. More...
	SignedKhalimskyCell (SignedKhalimskyCell &&other)=default
	Move constructor. More...
SignedKhalimskyCell &	operator= (SignedKhalimskyCell &&other)=default
	Move operator. More...
bool	operator== (const SignedKhalimskyCell &other) const
	Equality operator. More...
bool	operator!= (const SignedKhalimskyCell &other) const
	Difference operator. More...
bool	operator< (const SignedKhalimskyCell &other) const
	Inferior operator. (lexicographic order). More...
std::string	className () const
	Return the style name used for drawing this object. More...

Private Member Functions
	SignedKhalimskyCell (const Point &aPoint, bool positive)
	Explicit constructor from its Khalimsky coordinates. More...
	SignedKhalimskyCell (const SPreCell &aCell)
	Explicit constructor from a SignedKhalimskyPreCell. More...
	operator SPreCell & ()
	Mutable conversion to SignedKhalimskyPreCell. More...

Private Attributes
SPreCell	mySPreCell
	Underlying signed pre-cell. More...

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

dim	the dimension of the digital space.
TInteger	the Integer class used to specify the arithmetic computations (default type = int32).

Examples

dec/exampleDECSurface.cpp, geometry/volumes/digitalPolyhedronBuilder3D.cpp, geometry/volumes/fullConvexityShortestPaths3D.cpp, geometry/volumes/fullConvexitySphereGeodesics.cpp, geometry/volumes/standardDigitalPolyhedronBuilder3D.cpp, io/viewers/viewer3D-10-interaction.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

CellularGridSpace

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.

Integer

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

using DGtal::SignedKhalimskyCell< dim, TInteger >::Integer = TInteger

Definition at line 215 of file KhalimskySpaceND.h.

Point

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.

PreCellularGridSpace

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.

Self

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.

SPreCell

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.

UnsignedInteger

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

SignedKhalimskyCell() [1/5]

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

aPoint	any point.
positive	if cell has positive sign.

SignedKhalimskyCell() [2/5]

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

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const SPreCell &  aCell )

explicitprivate

Explicit constructor from a SignedKhalimskyPreCell.

Parameters

aCell

a pre-cell.

SignedKhalimskyCell() [3/5]

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

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( Integer  dummy = 0 )

explicit

Default constructor.

SignedKhalimskyCell() [4/5]

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

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( const SignedKhalimskyCell< dim, TInteger > &  other )

default

Copy constructor.

Parameters

other

any other cell.

SignedKhalimskyCell() [5/5]

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

DGtal::SignedKhalimskyCell< dim, TInteger >::SignedKhalimskyCell ( SignedKhalimskyCell< dim, TInteger > &&  other )

default

Move constructor.

Parameters

other

any other cell.

Member Function Documentation

BOOST_CONCEPT_ASSERT()

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

DGtal::SignedKhalimskyCell< dim, TInteger >::BOOST_CONCEPT_ASSERT

(

(concepts::CInteger< TInteger >)

)

Integer must be a model of the concept CInteger.

className()

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

std::string DGtal::SignedKhalimskyCell< dim, TInteger >::className

(

)

const

Return the style name used for drawing this object.

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.

Referenced by main(), testCellDrawOnBoard(), and testDigitization().

operator SPreCell &()

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

DGtal::SignedKhalimskyCell< dim, TInteger >::operator SPreCell & ( )

explicitprivate

Mutable conversion to SignedKhalimskyPreCell.

operator SPreCell const &()

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

DGtal::SignedKhalimskyCell< dim, TInteger >::operator SPreCell const &

(

)

const

Constant conversion to SignedKhalimskyPreCell.

operator!=()

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

bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator!=

(

const SignedKhalimskyCell< dim, TInteger > &

other

)

const

Difference operator.

Parameters

other

any other cell.

operator<()

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

other

any other cell.

operator=() [1/2]

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

SignedKhalimskyCell & DGtal::SignedKhalimskyCell< dim, TInteger >::operator= ( const SignedKhalimskyCell< dim, TInteger > &  other )

default

Copy operator.

Parameters

other

any other cell.

operator=() [2/2]

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

SignedKhalimskyCell & DGtal::SignedKhalimskyCell< dim, TInteger >::operator= ( SignedKhalimskyCell< dim, TInteger > &&  other )

default

Move operator.

Parameters

other

any other cell.

operator==()

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

bool DGtal::SignedKhalimskyCell< dim, TInteger >::operator==

(

const SignedKhalimskyCell< dim, TInteger > &

other

)

const

Equality operator.

Parameters

other

any other cell.

preCell()

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

SPreCell const & DGtal::SignedKhalimskyCell< dim, TInteger >::preCell

(

)

const

Returns the underlying constant signed pre-cell.

Referenced by std::hash< DGtal::SignedKhalimskyCell< dim, TInteger > >::operator()(), boost::hash< DGtal::SignedKhalimskyCell< dim, TInteger > >::operator()(), DGtal::RayIntersectionPredicate< TPoint >::operator()(), and DGtal::TransformedPrism::TransformedPrism().

Friends And Related Function Documentation

KhalimskySpaceND< dim, TInteger >

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

friend class KhalimskySpaceND< dim, TInteger >

friend

Definition at line 211 of file KhalimskySpaceND.h.

KhalimskySpaceNDHelper< CellularGridSpace >

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

friend class KhalimskySpaceNDHelper< CellularGridSpace >

friend

Definition at line 211 of file KhalimskySpaceND.h.

Field Documentation

mySPreCell

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

SPreCell DGtal::SignedKhalimskyCell< dim, TInteger >::mySPreCell

private

Underlying signed pre-cell.

Definition at line 229 of file KhalimskySpaceND.h.

---

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

• KhalimskySpaceND.h