Namespaces | Data Structures | Typedefs | Enumerations | Functions | Variables

DGtal Namespace Reference

DGtal is the top-level namespace which contains all DGtal functions and types. More...

Namespaces

namespace  deprecated
namespace  experimental
namespace  Z2i
namespace  Z3i

Data Structures

struct  TrueBoolFct0
struct  FalseBoolFct0
struct  IdentityBoolFct1
struct  NotBoolFct1
struct  AndBoolFct2
struct  OrBoolFct2
struct  XorBoolFct2
struct  ImpliesBoolFct2
struct  MinFunctor
struct  MaxFunctor
struct  MinusFunctor
class  POW
class  POW< X, 1 >
class  LOG2
class  LOG2< 2 >
class  LOG2< 1 >
struct  Bits
struct  DrawableWithDGtalBoard
class  Common
class  CountedPtr
 Aim: Smart pointer based on reference counts. More...
class  CowPtr
 Aim: Copy on write shared pointer. More...
class  IOException
class  MemoryException
class  InputException
class  OrderedAlphabet
 Aim: Describes an alphabet over an interval of (ascii) letters, where the lexicographic order can be changed (shifted, reversed, ...). Useful for the arithmetic minimum length polygon (AMLP). More...
class  ArithmeticalDSS
 Aim: Recognition of a digital straight segment (DSS) defined as the sequence of connected points (x,y) such that mu <= ax - by < mu + omega. (see Debled and Reveilles (1995)). More...
struct  DrawDSSBoundingBox
struct  DrawDSSPoints
class  StandardBase
 Aim: Provide static methods for the recognition of a standard DSS (4-connected) such that omega = |a|+|b|. More...
class  NaiveBase
 Aim: Provide elementary services for the recognition of a naive DSS (8-connected) such that omega = max(|a|,|b|). More...
class  FreemanChain
class  GreedyDecomposition
 Aim: Computes the greedy decomposition of a contour into primitives (the last point of the primitive i is the first point of the primitive i+1). More...
class  Point2ShapePredicate
 Aim: Predicate returning true iff the point is in the 'interior' of the shape following the concept of CPointPredicate. More...
struct  Point2ShapePredicateComparator
struct  Point2ShapePredicateComparator< T, false, false >
struct  Point2ShapePredicateComparator< T, false, true >
struct  Point2ShapePredicateComparator< T, true, false >
struct  Point2ShapePredicateComparator< T, true, true >
class  Preimage2D
 Aim: Computes the preimage of the 2D Euclidean shapes crossing a sequence of straigth segments in linear-time according to the algorithm of O'Rourke (1981). More...
class  StraightLine
 Aim: Represents a StraightLine uniquely defined by two 2D points and that is able to return for each 2D point of the domain its signed distance to itself. More...
struct  CSeparableMetric
class  DistanceTransformation
 Aim: Implementation of the linear in time distance transformation for a class of separable metrics (see SeparableMetric). More...
struct  SeparableMetricTraits
 Aim: Implements basic functions associated to metrics used by separable volumetric algorithms. More...
struct  SeparableMetricTraits< TAbscissa, TValueType, 2 >
struct  SeparableMetricTraits< TAbscissa, TValueType, 1 >
struct  SeparableMetricTraits< TAbscissa, TValueType, 0 >
class  Shapes
 Aim: A utility class for constructing different shapes (balls, diamonds, and others). More...
class  StdDefs
 Aim: More...
class  DGtalInventor
 Aim: A stream object based on Open Inventor for exporting or displaying DGtal objects. More...
class  IVViewer
 Aim: A facade to represent an inventor window for 3D objects. May be a SoXt or a SoQt examiner viewer. NB: backported from ImaGeneUtils library. More...
class  Lattice
 Aim: Represents an n-dimensional integer lattice in an m-dimensional real vector space. More...
struct  CDrawableWithDGtalBoard
struct  CColorMap
 Aim: Defines the concept describing a color map. A color map converts a value within a given range into an RGB triple. More...
class  ColorBrightnessColorMap
 Aim: This class template may be used to (linearly) convert scalar values in a given range into a color with given lightness. More...
class  GradientColorMap
 Aim: This class template may be used to (linearly) convert scalar values in a given range into a color in a gradient defined by two or more colors. More...
class  GrayscaleColorMap
 Aim: This class template may be used to (linearly) convert scalar values in a given range into gray levels. More...
class  HueShadeColorMap
 Aim: This class template may be used to (linearly) convert scalar values in a given range into a color in a cyclic hue shade colormap, maybe aka rainbow color map. This color map is suitable, for example, to colorize distance functions. By default, only one hue cycle is used. More...
class  DGtalBoard
 Aim: This class specializes a 'Board' class so as to display DGtal objects more naturally (with <<). The user has simply to declare a DGtalBoard object and uses stream operators to display most digital objects. Furthermore, one can use this class to modify the current style for drawing. More...
struct  DrawWithBoardModifier
struct  CustomStyle
struct  SetMode
struct  CustomColors
struct  CustomPenColor
struct  CustomFillColor
struct  CustomPen
struct  MagickReader
 Aim: implements methods to read a 2D image using the ImageMagick library. More...
struct  RawReader
 Aim: implements methods to read a "Vol" file format. More...
struct  VolReader
 Aim: implements methods to read a "Vol" file format. More...
struct  PNMWriter
 Aim: Export a 2D and a 3D Image using the Netpbm formats (ASCII mode).

  • PPM: RGB
  • PGM: grayscale
  • PPM3D: 3D variant of PPM
  • PGM3D: 3D variant of PGM.
More...
struct  RawWriter
 Aim: Raw binary export of an Image. More...
struct  VolWriter
 Aim: Export a 3D Image using the Vol formats. More...
struct  ConstantPointPredicate
 Aim: The predicate that returns always the same value boolCst. More...
struct  TruePointPredicate
 Aim: The predicate that returns always true. More...
struct  FalsePointPredicate
 Aim: The predicate that returns always false. More...
struct  IsLowerPointPredicate
 Aim: The predicate returns true when the point is below (or equal) the given upper bound. More...
struct  IsUpperPointPredicate
 Aim: The predicate returns true when the point is above (or equal) the given lower bound. More...
struct  IsWithinPointPredicate
 Aim: The predicate returns true when the point is within the given bounds. More...
struct  NotPointPredicate
 Aim: The predicate returns true when the point is within the given bounds. More...
struct  BinaryPointPredicate
 Aim: The predicate returns true when the point is within the given bounds. More...
struct  CInteger
 Aim: The concept CInteger specifies what are the usual integer numbers, more precisely the ones that are representable on a computer. More...
struct  CPointPredicate
 Aim: Defines a predicate on a point. More...
struct  CSpace
 Aim: Defines the concept describing a digital space, ie a cartesian product of integer lines. More...
struct  CUnsignedInteger
struct  CDomain
 Aim: This concept represents a digital domain, i.e. a non mutable subset of points of the given digital space. More...
struct  DomainPredicate
 Aim: The predicate returning true iff the point is in the domain given at construction. It is just a wrapper class around the methods Domain::isInside( const Point & ), where Domain stands for any model of CDomain. More...
class  HyperRectDomain
 Aim: Parallelepidec region of a digital space, model of a 'CDomain'. More...
struct  DrawDomainGrid
struct  DrawDomainPaving
class  HyperRectDomain_Iterator
struct  CImageContainer
struct  CValueType
class  ImageContainerBySTLMap
class  ImageContainerBySTLVector
struct  ImageSelector
 Aim: Automatically defines an adequate image type according to the hints given by the user. More...
class  Morton
 Aim: More...
struct  IntegerTraits
 Aim: The traits class for all models of Cinteger. More...
struct  IntegerTraits< uint16_t >
struct  IntegerTraits< int16_t >
struct  IntegerTraits< uint32_t >
struct  IntegerTraits< int32_t >
struct  IntegerTraits< uint64_t >
struct  IntegerTraits< int64_t >
class  Warning_promote_trait_not_specialized_for_this_case
struct  promote_trait
struct  promote_trait< int32_t, int64_t >
class  Matrix
class  PointVector
 Aim: Implements basic operations that will be used in Point and Vector classes. More...
struct  DrawPavingPixel
struct  DrawGridPixel
struct  CDigitalSet
class  DigitalSetBySTLSet
 Aim: More...
class  DigitalSetBySTLVector
 Aim: Realizes the concept CDigitalSet by using the STL container std::vector. More...
struct  DigitalSetConverter
 Aim: Utility class to convert between types of sets. More...
class  DigitalSetDomain
 Aim: Constructs a domain limited to the given digital set. More...
struct  DigitalSetSelector
 Aim: Automatically defines an adequate digital set type according to the hints given by the user. More...
struct  SetPredicate
 Aim: The predicate returning true iff the point is in the domain given at construction. More...
class  SpaceND
class  ModuloComputer
 implements basic functions on modular arithmetic. More...
class  MeasureOfStraightLines
struct  CAdjacency
 Aim: The concept CAdjacency defines an elementary adjacency relation between points of a digital space. More...
struct  CDomainAdjacency
 Aim: Refines the concept CAdjacency by telling that the adjacency is specific to a given domain of the embedding digital space. More...
class  DigitalTopology
 Aim: Represents a digital topology as a couple of adjacency relations. More...
class  DomainAdjacency
 Aim: Given a domain and an adjacency, limits the given adjacency to the specified domain for all adjacency and neighborhood computations. More...
class  Expander
 Aim: This class is useful to visit an object by adjacencies, layer by layer. More...
class  MetricAdjacency
 Aim: Describes digital adjacencies in digital spaces that are defined with the 1-norm and the infinity-norm. More...
class  Object
 Aim: An object (or digital object) represents a set in some digital space associated with a digital topology. More...
struct  DrawObjectAdjacencies
class  Clock
struct  TagFalse
struct  TagTrue
struct  TagUnknown
class  ConceptUtils
 Aim: This utility class gathers several static methods useful for concept checks. More...
struct  OpInSTLContainers
struct  OpInSTLContainers< Container, std::reverse_iterator< typename Container::iterator > >
class  Trace
class  TraceWriter
class  TraceWriterFile
class  TraceWriterTerm

Typedefs

typedef boost::function0< bool > BoolFunction0
typedef boost::function1< bool,
bool > 
BoolFunction1
typedef boost::function2< bool,
bool, bool > 
BoolFunction2
typedef boost::function3< bool,
bool, bool, bool > 
BoolFunction3
typedef unsigned int uint
typedef boost::uint16_t uint16_t
typedef boost::uint32_t uint32_t
typedef boost::uint64_t uint64_t
typedef boost::int16_t int16_t
typedef boost::int32_t int32_t
typedef boost::int64_t int64_t
typedef MetricAdjacency
< SpaceND< 2 >, 1 > 
Z2Adj4
typedef MetricAdjacency
< SpaceND< 2 >, 2 > 
Z2Adj8
typedef MetricAdjacency
< SpaceND< 3 >, 1 > 
Z3Adj6
typedef MetricAdjacency
< SpaceND< 3 >, 2 > 
Z3Adj18
typedef MetricAdjacency
< SpaceND< 3 >, 3 > 
Z3Adj26

Enumerations

enum  ColorGradientPreset {
  CMAP_CUSTOM = 0, CMAP_GRAYSCALE, CMAP_SPRING, CMAP_SUMMER,
  CMAP_AUTUMN, CMAP_WINTER, CMAP_COOL, CMAP_COPPER,
  CMAP_HOT, CMAP_JET
}
enum  DomainDrawMode { GRID = 0, PAVING = 1 }
enum  ImageIterability { HIGH_ITER_I = 0, LOW_ITER_I = 1 }
enum  ImageBelongTestability { HIGH_BEL_I = 0, LOW_BEL_I = 2 }
enum  ImageSpecificContainer { NORMAL_CONTAINER_I = 0, VTKIMAGEDATA_CONTAINER_I = 4 }
enum  BoundEnum { BOUNDED = 0, UNBOUNDED = 1, BOUND_UNKNOWN = 2 }
enum  SignEnum { SIGNED = 0, UNSIGNED = 1, SIGN_UNKNOWN = 2 }
enum  DigitalSetSize { SMALL_DS = 0, MEDIUM_DS = 1, BIG_DS = 2, WHOLE_DS = 3 }
enum  DigitalSetVariability { LOW_VAR_DS = 0, HIGH_VAR_DS = 4 }
enum  DigitalSetIterability { LOW_ITER_DS = 0, HIGH_ITER_DS = 8 }
enum  DigitalSetBelongTestability { LOW_BEL_DS = 0, HIGH_BEL_DS = 16 }
enum  DigitalTopologyProperties { UNKNOWN_DT = 0, NOT_JORDAN_DT = 1, JORDAN_DT = 2 }

Functions

std::ostream & operator<< (std::ostream &out, const Common &object)
template<typename T >
std::ostream & operator<< (std::ostream &out, const CountedPtr< T > &object)
template<typename T >
std::ostream & operator<< (std::ostream &out, const CowPtr< T > &object)
std::ostream & operator<< (std::ostream &out, const OrderedAlphabet &object)
template<typename TDSS >
std::ostream & operator<< (std::ostream &out, ArithmeticalDSS< TDSS > &object)
template<typename TInteger >
std::ostream & operator<< (std::ostream &out, const FreemanChain< TInteger > &object)
template<typename Contour , typename Primitive >
std::ostream & operator<< (std::ostream &out, const GreedyDecomposition< Contour, Primitive > &object)
template<typename Shape , bool isUpward, bool isClosed>
std::ostream & operator<< (std::ostream &out, const Point2ShapePredicate< Shape, isUpward, isClosed > &object)
template<typename Shape >
std::ostream & operator<< (std::ostream &out, const Preimage2D< Shape > &object)
template<typename TInteger >
std::ostream & operator<< (std::ostream &out, const StraightLine< TInteger > &object)
template<typename TDomain >
std::ostream & operator<< (std::ostream &out, const Shapes< TDomain > &object)
std::ostream & operator<< (std::ostream &out, const StdDefs &object)
template<typename TSpace >
std::ostream & operator<< (std::ostream &out, const DGtalInventor< TSpace > &object)
std::ostream & operator<< (std::ostream &out, const IVViewer &object)
template<typename TSpace >
std::ostream & operator<< (std::ostream &out, const Lattice< TSpace > &object)
template<typename PValueType , int PDefaultColor>
std::ostream & operator<< (std::ostream &out, const ColorBrightnessColorMap< PValueType, PDefaultColor > &object)
template<typename PValueType , int PDefaultPreset, int PDefaultFirstColor, int PDefaultLastColor>
std::ostream & operator<< (std::ostream &out, const GradientColorMap< PValueType, PDefaultPreset, PDefaultFirstColor, PDefaultLastColor > &object)
template<typename PValueType >
std::ostream & operator<< (std::ostream &out, const GrayscaleColorMap< PValueType > &object)
template<typename PValueType , int DefaultCycles>
std::ostream & operator<< (std::ostream &out, const HueShadeColorMap< PValueType, DefaultCycles > &object)
std::ostream & operator<< (std::ostream &out, const DGtalBoard &object)
template<typename TSpace >
std::ostream & operator<< (std::ostream &out, const HyperRectDomain< TSpace > &object)
template<typename T , typename TV >
std::ostream & operator<< (std::ostream &out, const experimental::ImageContainerByITKImage< T, TV > &object)
template<typename Domain , typename V >
std::ostream & operator<< (std::ostream &out, const ImageContainerBySTLVector< Domain, V > &object)
std::ostream & operator<< (std::ostream &out, const Matrix &object)
template<std::size_t N, typename T >
std::ostream & operator<< (std::ostream &out, const PointVector< N, T > &object)
template<typename Domain >
std::ostream & operator<< (std::ostream &out, const DigitalSetBySTLSet< Domain > &object)
template<typename Domain >
std::ostream & operator<< (std::ostream &out, const DigitalSetBySTLVector< Domain > &object)
template<typename T >
std::ostream & operator<< (std::ostream &out, const DigitalSetDomain< T > &object)
template<std::size_t dim, typename Integer , typename Size , typename Dimension >
static std::ostream & operator<< (std::ostream &out, const SpaceND< dim, Integer, Size, Dimension > &object)
template<typename T >
std::ostream & operator<< (std::ostream &out, const ModuloComputer< T > &object)
std::ostream & operator<< (std::ostream &out, const MeasureOfStraightLines &object)
template<typename TForegroundAdjacency , typename TBackgroundAdjacency >
std::ostream & operator<< (std::ostream &out, const DigitalTopology< TForegroundAdjacency, TBackgroundAdjacency > &object)
template<typename TDomain , typename TAdjacency >
std::ostream & operator<< (std::ostream &out, const DomainAdjacency< TDomain, TAdjacency > &object)
template<typename T >
std::ostream & operator<< (std::ostream &out, const Expander< T > &object)
template<typename TSpace , std::size_t maxNorm1>
std::ostream & operator<< (std::ostream &out, const MetricAdjacency< TSpace, maxNorm1, TSpace::staticDimension > &object)
template<typename TDigitalTopology , typename TDigitalSet >
std::ostream & operator<< (std::ostream &out, const Object< TDigitalTopology, TDigitalSet > &object)
std::ostream & operator<< (std::ostream &out, const Clock &object)
std::ostream & operator<< (std::ostream &out, const Trace &object)
std::ostream & operator<< (std::ostream &out, const TraceWriter &object)
std::ostream & operator<< (std::ostream &out, const TraceWriterFile &object)
std::ostream & operator<< (std::ostream &out, const TraceWriterTerm &object)

Variables

static const BoolFunction0 trueBF0 = TrueBoolFct0()
static const BoolFunction0 falseBF0 = FalseBoolFct0()
static const BoolFunction1 identityBF1 = IdentityBoolFct1()
static const BoolFunction1 notBF1 = NotBoolFct1()
static const BoolFunction2 andBF2 = AndBoolFct2()
static const BoolFunction2 orBF2 = OrBoolFct2()
static const BoolFunction2 xorBF2 = XorBoolFct2()
static const BoolFunction2 impliesBF2 = ImpliesBoolFct2()
TraceWriterTerm traceWriterTerm
Trace trace

Detailed Description

DGtal is the top-level namespace which contains all DGtal functions and types.


Typedef Documentation

typedef boost::function0< bool > DGtal::BoolFunction0

May hold bool functions taking no arguments.

typedef boost::function1< bool, bool > DGtal::BoolFunction1

May hold bool functions taking one bool argument.

typedef boost::function2< bool, bool, bool > DGtal::BoolFunction2

May hold bool functions taking two bool arguments.

typedef boost::function3< bool, bool, bool, bool > DGtal::BoolFunction3

May hold bool functions taking three bool arguments (Useful ?).

typedef boost::int16_t DGtal::int16_t
typedef boost::int32_t DGtal::int32_t
typedef boost::int64_t DGtal::int64_t
typedef unsigned int DGtal::uint
typedef boost::uint16_t DGtal::uint16_t
typedef boost::uint32_t DGtal::uint32_t
typedef boost::uint64_t DGtal::uint64_t

Standard 4-neighborhood for a 2D digital space based on type 'int'.

Standard 8-neighborhood for a 2D digital space based on type 'int'.

Standard 18-neighborhood for a 3D digital space based on type 'int'.

Standard 26-neighborhood for a 3D digital space based on type 'int'.

Standard 6-neighborhood for a 3D digital space based on type 'int'.


Enumeration Type Documentation

Enumerator:
BOUNDED 
UNBOUNDED 
BOUND_UNKNOWN 
Enumerator:
CMAP_CUSTOM 
CMAP_GRAYSCALE 
CMAP_SPRING 
CMAP_SUMMER 
CMAP_AUTUMN 
CMAP_WINTER 
CMAP_COOL 
CMAP_COPPER 
CMAP_HOT 
CMAP_JET 
Enumerator:
LOW_BEL_DS 
HIGH_BEL_DS 
Enumerator:
LOW_ITER_DS 
HIGH_ITER_DS 
Enumerator:
SMALL_DS 
MEDIUM_DS 
BIG_DS 
WHOLE_DS 
Enumerator:
LOW_VAR_DS 
HIGH_VAR_DS 

Possible properties of digital topologies.

Enumerator:
UNKNOWN_DT 
NOT_JORDAN_DT 
JORDAN_DT 

Specifies the drawing mode for domains.

Enumerator:
GRID 
PAVING 
Enumerator:
HIGH_BEL_I 
LOW_BEL_I 
Enumerator:
HIGH_ITER_I 
LOW_ITER_I 
Enumerator:
NORMAL_CONTAINER_I 
VTKIMAGEDATA_CONTAINER_I 
Enumerator:
SIGNED 
UNSIGNED 
SIGN_UNKNOWN 

Function Documentation

std::ostream& DGtal::operator<< ( std::ostream &  out,
const Common &  object 
) [inline]

Overloads 'operator<<' for displaying objects of class 'Common'.

Parameters:
out the output stream where the object is written.
object the object of class 'Common' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const TraceWriterTerm &  object 
)

Overloads 'operator<<' for displaying objects of class 'TraceWriterTerm'.

Parameters:
out the output stream where the object is written.
object the object of class 'TraceWriterTerm' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const TraceWriterFile &  object 
)

Overloads 'operator<<' for displaying objects of class 'TraceWriterFile'.

Parameters:
out the output stream where the object is written.
object the object of class 'TraceWriterFile' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const TraceWriter &  object 
)

Overloads 'operator<<' for displaying objects of class 'TraceWriter'.

Parameters:
out the output stream where the object is written.
object the object of class 'TraceWriter' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Trace &  object 
)

Overloads 'operator<<' for displaying objects of class 'Trace'.

Parameters:
out the output stream where the object is written.
object the object of class 'Trace' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Clock &  object 
) [inline]

Overloads 'operator<<' for displaying objects of class 'Clock'.

Parameters:
out the output stream where the object is written.
object the object of class 'Clock' to write.
Returns:
the output stream after the writing.
template<typename TDigitalTopology , typename TDigitalSet >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Object< TDigitalTopology, TDigitalSet > &  object 
)

Overloads 'operator<<' for displaying objects of class 'Object'.

Parameters:
out the output stream where the object is written.
object the object of class 'Object' to write.
Returns:
the output stream after the writing.
template<typename TSpace , std::size_t maxNorm1>
std::ostream& DGtal::operator<< ( std::ostream &  out,
const MetricAdjacency< TSpace, maxNorm1, TSpace::staticDimension > &  object 
)

Overloads 'operator<<' for displaying objects of class 'MetricAdjacency'.

Parameters:
out the output stream where the object is written.
object the object of class 'MetricAdjacency' to write.
Returns:
the output stream after the writing.
template<typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Expander< T > &  object 
)

Overloads 'operator<<' for displaying objects of class 'Expander'.

Parameters:
out the output stream where the object is written.
object the object of class 'Expander' to write.
Returns:
the output stream after the writing.
template<typename TDomain , typename TAdjacency >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DomainAdjacency< TDomain, TAdjacency > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DomainAdjacency'.

Parameters:
out the output stream where the object is written.
object the object of class 'DomainAdjacency' to write.
Returns:
the output stream after the writing.
template<typename TForegroundAdjacency , typename TBackgroundAdjacency >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DigitalTopology< TForegroundAdjacency, TBackgroundAdjacency > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DigitalTopology'.

Parameters:
out the output stream where the object is written.
object the object of class 'DigitalTopology' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const MeasureOfStraightLines &  object 
)

Overloads 'operator<<' for displaying objects of class 'MeasureOfStraightLines'.

Parameters:
out the output stream where the object is written.
object the object of class 'MeasureOfStraightLines' to write.
Returns:
the output stream after the writing.
template<typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const ModuloComputer< T > &  object 
)
template<std::size_t dim, typename Integer , typename Size , typename Dimension >
static std::ostream& DGtal::operator<< ( std::ostream &  out,
const SpaceND< dim, Integer, Size, Dimension > &  object 
) [static]

Overloads 'operator<<' for displaying objects of class 'SpaceND'.

Parameters:
out the output stream where the object is written.
object the object of class 'SpaceND' to write.
Returns:
the output stream after the writing.
template<typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DigitalSetDomain< T > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DigitalSetDomain'.

Parameters:
out the output stream where the object is written.
object the object of class 'DigitalSetDomain' to write.
Returns:
the output stream after the writing.
template<typename Domain >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DigitalSetBySTLVector< Domain > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DigitalSetBySTLVector'.

Parameters:
out the output stream where the object is written.
object the object of class 'DigitalSetBySTLVector' to write.
Returns:
the output stream after the writing.
template<typename Domain >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DigitalSetBySTLSet< Domain > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DigitalSetBySTLSet'.

Parameters:
out the output stream where the object is written.
object the object of class 'DigitalSetBySTLSet' to write.
Returns:
the output stream after the writing.
template<std::size_t N, typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const PointVector< N, T > &  object 
)

Operator <<.

std::ostream& DGtal::operator<< ( std::ostream &  out,
const Matrix &  object 
)

Overloads 'operator<<' for displaying objects of class 'Matrix'.

Parameters:
out the output stream where the object is written.
object the object of class 'Matrix' to write.
Returns:
the output stream after the writing.
template<typename Domain , typename V >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const ImageContainerBySTLVector< Domain, V > &  object 
) [inline]

Overloads 'operator<<' for displaying objects of class 'Image'.

Parameters:
out the output stream where the object is written.
object the object of class 'Image' to write.
Returns:
the output stream after the writing.
template<typename T , typename TV >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const experimental::ImageContainerByITKImage< T, TV > &  object 
)

Overloads 'operator<<' for displaying objects of class 'ImageContainerByITKImage'.

Parameters:
out the output stream where the object is written.
object the object of class 'ImageContainerByITKImage' to write.
Returns:
the output stream after the writing.
template<typename TSpace >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const HyperRectDomain< TSpace > &  object 
)

Overloads 'operator<<' for displaying objects of class 'HyperRectDomain'.

Parameters:
out the output stream where the object is written.
object the object of class 'HyperRectDomain' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DGtalBoard &  object 
)

Overloads 'operator<<' for displaying objects of class 'DGtalBoard'.

Parameters:
out the output stream where the object is written.
object the object of class 'DGtalBoard' to write.
Returns:
the output stream after the writing.
template<typename PValueType , int DefaultCycles>
std::ostream& DGtal::operator<< ( std::ostream &  out,
const HueShadeColorMap< PValueType, DefaultCycles > &  object 
)

Overloads 'operator<<' for displaying objects of class 'HueShadeColorMap'.

Parameters:
out the output stream where the object is written.
object the object of class 'HueShadeColorMap' to write.
Returns:
the output stream after the writing.
template<typename PValueType >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const GrayscaleColorMap< PValueType > &  object 
)

Overloads 'operator<<' for displaying objects of class 'GrayscaleColorMap'.

Parameters:
out the output stream where the object is written.
object the object of class 'GrayscaleColorMap' to write.
Returns:
the output stream after the writing.
template<typename PValueType , int PDefaultPreset, int PDefaultFirstColor, int PDefaultLastColor>
std::ostream& DGtal::operator<< ( std::ostream &  out,
const GradientColorMap< PValueType, PDefaultPreset, PDefaultFirstColor, PDefaultLastColor > &  object 
)

Overloads 'operator<<' for displaying objects of class 'GradientColorMap'.

Parameters:
out the output stream where the object is written.
object the object of class 'GradientColorMap' to write.
Returns:
the output stream after the writing.
template<typename PValueType , int PDefaultColor>
std::ostream& DGtal::operator<< ( std::ostream &  out,
const ColorBrightnessColorMap< PValueType, PDefaultColor > &  object 
)

Overloads 'operator<<' for displaying objects of class 'ColorBrightnessColorMap'.

Parameters:
out the output stream where the object is written.
object the object of class 'ColorBrightnessColorMap' to write.
Returns:
the output stream after the writing.
template<typename TSpace >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Lattice< TSpace > &  object 
)

Overloads 'operator<<' for displaying objects of class 'Lattice'.

Parameters:
out the output stream where the object is written.
object the object of class 'Lattice' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const IVViewer &  object 
)

Overloads 'operator<<' for displaying objects of class 'IVViewer'.

Parameters:
out the output stream where the object is written.
object the object of class 'IVViewer' to write.
Returns:
the output stream after the writing.
template<typename TSpace >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const DGtalInventor< TSpace > &  object 
)

Overloads 'operator<<' for displaying objects of class 'DGtalInventor'.

Parameters:
out the output stream where the object is written.
object the object of class 'DGtalInventor' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const StdDefs &  object 
)

Overloads 'operator<<' for displaying objects of class 'StdDefs'.

Parameters:
out the output stream where the object is written.
object the object of class 'StdDefs' to write.
Returns:
the output stream after the writing.
template<typename TDomain >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Shapes< TDomain > &  object 
)

Overloads 'operator<<' for displaying objects of class 'Shapes'.

Parameters:
out the output stream where the object is written.
object the object of class 'Shapes' to write.
Returns:
the output stream after the writing.
template<typename TInteger >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const StraightLine< TInteger > &  object 
) [inline]
template<typename Shape >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Preimage2D< Shape > &  object 
)

Overloads 'operator<<' for displaying objects of class 'Preimage2D'.

Parameters:
out the output stream where the object is written.
object the object of class 'Preimage2D' to write.
Returns:
the output stream after the writing.
template<typename Shape , bool isUpward, bool isClosed>
std::ostream& DGtal::operator<< ( std::ostream &  out,
const Point2ShapePredicate< Shape, isUpward, isClosed > &  object 
) [inline]
template<typename Contour , typename Primitive >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const GreedyDecomposition< Contour, Primitive > &  object 
)

Overloads 'operator<<' for displaying objects of class 'GreedyDecomposition'.

Parameters:
out the output stream where the object is written.
object the object of class 'GreedyDecomposition' to write.
Returns:
the output stream after the writing.
template<typename TInteger >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const FreemanChain< TInteger > &  object 
)

Overloads 'operator<<' for displaying objects of class 'FreemanChain'.

Parameters:
out the output stream where the object is written.
object the object of class 'FreemanChain' to write.
Returns:
the output stream after the writing.
template<typename TDSS >
std::ostream& DGtal::operator<< ( std::ostream &  out,
ArithmeticalDSS< TDSS > &  object 
)

Overloads 'operator<<' for displaying objects of class 'ArithmeticalDSS'.

Parameters:
out the output stream where the object is written.
object the object of class 'ArithmeticalDSS' to write.
Returns:
the output stream after the writing.
std::ostream& DGtal::operator<< ( std::ostream &  out,
const OrderedAlphabet &  object 
)

Overloads 'operator<<' for displaying objects of class 'OrderedAlphabet'.

Parameters:
out the output stream where the object is written.
object the object of class 'OrderedAlphabet' to write.
Returns:
the output stream after the writing.
template<typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const CowPtr< T > &  object 
)

Overloads 'operator<<' for displaying objects of class 'CowPtr'.

Parameters:
out the output stream where the object is written.
object the object of class 'CowPtr' to write.
Returns:
the output stream after the writing.
template<typename T >
std::ostream& DGtal::operator<< ( std::ostream &  out,
const CountedPtr< T > &  object 
)

Overloads 'operator<<' for displaying objects of class 'CountedPtr'.

Parameters:
out the output stream where the object is written.
object the object of class 'CountedPtr' to write.
Returns:
the output stream after the writing.

Variable Documentation

The object function and (2 bool args).

Referenced by testBasicBoolFunctions().

The object function (0 bool args) returning false.

Referenced by testBasicBoolFunctions().

The object function identity (1 bool args).

Referenced by testBasicBoolFunctions().

The object function implies (2 bool args).

Referenced by testBasicBoolFunctions().

The object function NOT (1 bool args).

Referenced by testBasicBoolFunctions().

The object function or (2 bool args).

Referenced by testBasicBoolFunctions().

Examples:
dgtalboard-1-points.cpp, dgtalboard-2-sets.cpp, dgtalboard-3-custom-classes.cpp, dgtalboard-3-custom-points.cpp, dgtalboard-4-colormaps.cpp, dgtalboard-5-greedy-dss.cpp, distancetransform2D.cpp, and DSS.cpp.

Referenced by builtinIteratorScan(), domainIteratorScan(), main(), test_loopTick(), test_minimalTick(), test_MultipleLoop(), testBadKeySizes(), testBasicBoolFunctions(), testCheckImageConcept(), testChessboard(), testComparison(), testDGtalBoard(), testDigitalSet(), testDigitalSetDomain(), testDigitalSetDraw(), testDigitalSetSelector(), testDigitalTopologyZ2(), testDistanceTransformation(), testDistanceTransformation3D(), testDistanceTransformationBorder(), testDomain(), testDraw(), testDuvalPP(), testDuvalPPMod(), testExpander(), testFileStream(), testFLF(), testFreemanChain(), testGetSetVal(), testGrayscaleColorMap(), testHashTree(), testImageContainerBenchmark(), testIndent(), testInteger(), testIntegerNorms(), testIOException(), testIterator(), testITKImage(), testIVViewer(), testIVViewerSimpleWdw(), testMagickReader(), testMetricAdjacency(), testModuloComputer(), testMorton(), testNorms(), testObject(), testObject3D(), testObjectBorder(), testOperators(), testOrderedAlphabet(), testPNMWriter(), testRawReader2D(), testReverseIterator(), testSimple(), testSimpleBoard(), testSimpleExpander(), testSimpleHyperRectDomain(), testSimpleImage(), testSimplePoint(), testSimplePoints2D(), testSimplePoints3D(), testSimpleVector(), testSpanIterators(), testSTLCompat(), testSuite(), testTypeValidity(), testUnitSquare(), testUnitSquareCentroid(), testVolReader(), and testVTKImageContainer().

DGtal Global variables

The object function (0 bool args) returning true.

Referenced by testBasicBoolFunctions().

The object function xor (2 bool args).

Referenced by testBasicBoolFunctions().