DGtal::ImageFromSet< TImage > Struct Template Reference

Aim: Define utilities to convert a digital set into an image. More...

#include <DGtal/images/imagesSetsUtils/ImageFromSet.h>

Public Types
typedef TImage	Image
typedef TImage::Value	Value

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CImage< Image >))

Static Public Member Functions
template<typename Set>
static Image	create (const Set &aSet, const Value &defaultValue, const bool addBorder, typename Set::ConstIterator itBegin, typename Set::ConstIterator itEnd, const bool keepSetDomain=false)
template<typename Set>
static Image	create (const Set &aSet, const Value &defaultValue, const bool addBorder=false, const bool keepSetDomain=false)
template<typename Set>
static void	append (Image &aImage, const Value &defaultValue, typename Set::ConstIterator itBegin, typename Set::ConstIterator itEnd)
template<typename Set>
static void	append (Image &aImage, const Set &aSet, const Value &defaultValue)

Detailed Description

template<typename TImage>
struct DGtal::ImageFromSet< TImage >

Aim: Define utilities to convert a digital set into an image.

Description of template class 'ImageFromSet'

Template Parameters

TImage

an model of CImageContainer concept.

Definition at line 63 of file ImageFromSet.h.

Member Typedef Documentation

Image

template<typename TImage>

typedef TImage DGtal::ImageFromSet< TImage >::Image

Definition at line 65 of file ImageFromSet.h.

Value

template<typename TImage>

typedef TImage::Value DGtal::ImageFromSet< TImage >::Value

Definition at line 66 of file ImageFromSet.h.

Member Function Documentation

append() [1/2]

template<typename TImage>

template<typename Set>

void DGtal::ImageFromSet< TImage >::append ( Image & aImage, const Set & aSet, const Value & defaultValue )

inlinestatic

Append a Set to an existing image. Only points in the Set contained in the image domain are considered.

Template Parameters

Set	model of CDigitalSet

Parameters

aImage	an image
aSet	an instance of Set to convert into an image
defaultValue	the default value for points in the set to copy.

Definition at line 152 of file ImageFromSet.h.

    {
      append<Set>(aImage,defaultValue,aSet.begin(),aSet.end());
    }

References append().

append() [2/2]

template<typename TImage>

template<typename Set>

void DGtal::ImageFromSet< TImage >::append ( Image & aImage, const Value & defaultValue, typename Set::ConstIterator itBegin, typename Set::ConstIterator itEnd )

static

Append a Set to an existing image. Only points in the Set between itBegin and itEnd contained in the image domain are considered.

Template Parameters

Set	model of CDigitalSet

Parameters

aImage	an image
defaultValue	the default value for points in the set
itBegin	ConstIterator on the set to specify the first point to copy of a Set.
itEnd	ConstIterator on the set to specify the last point to copy of a Set.

Referenced by append().

BOOST_CONCEPT_ASSERT()

template<typename TImage>

DGtal::ImageFromSet< TImage >::BOOST_CONCEPT_ASSERT

(

(concepts::CImage< Image >)

)

create() [1/2]

template<typename TImage>

template<typename Set>

Image DGtal::ImageFromSet< TImage >::create ( const Set & aSet, const Value & defaultValue, const bool addBorder, typename Set::ConstIterator itBegin, typename Set::ConstIterator itEnd, const bool keepSetDomain = false )

static

Create an Image from a DigitalSet. The size of the output image is given from the set bounding box.

Template Parameters

Set	model of CDigitalSet

Parameters

aSet	an instance of Set to convert into an image
defaultValue	the default value for points in the set
addBorder	if true, we add a border of size 1 of defaultValue around the set.
itBegin	ConstIterator on the set to specify the first point to copy.
itEnd	ConstIterator on the set to specify the last point to copy.
keepSetDomain	if true, the set domain is used to create the resulting image, else the bouding box of the set is used.

Returns

an image.

Referenced by create(), testBreadthFirstPropagation(), testDepthFirstPropagation(), and testDistancePropagation().

create() [2/2]

template<typename TImage>

template<typename Set>

Image DGtal::ImageFromSet< TImage >::create ( const Set & aSet, const Value & defaultValue, const bool addBorder = false, const bool keepSetDomain = false )

inlinestatic

Create an Image from a DigitalSet. The size of the output image is given from the set bounding box.

Template Parameters

Set	model of CDigitalSet

Parameters

aSet	an instance of Set to convert into an image
defaultValue	the default value for points in the set
addBorder	if true, we add a border of size 1 of defaultValue around the set.
keepSetDomain	if true, the set domain is used to create the resulting image, else the bouding box of the set is used.

Returns

an image.

Definition at line 114 of file ImageFromSet.h.

    {
      return create(aSet,defaultValue,addBorder,aSet.begin(), aSet.end(), keepSetDomain);
    }        

References create().

---

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

• ImageFromSet.h