Aim: implements a factory to produce images from a "bigger/original" one according to a given domain. More...

#include <DGtal/images/ImageFactoryFromImage.h>

Public Types
typedef ImageFactoryFromImage< TImageContainer >	Self

typedef TImageContainer	ImageContainer
	Types copied from the container.

typedef ImageContainer::Domain	Domain

typedef ImageContainer	OutputImage
	New types.

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CImage< TImageContainer >))
	Checking concepts.

	ImageFactoryFromImage (Alias< ImageContainer > anImage)

	~ImageFactoryFromImage ()

const Domain &	domain () const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

OutputImage *	requestImage (const Domain &aDomain)

void	flushImage (OutputImage *outputImage)

void	detachImage (OutputImage *outputImage)

Protected Attributes
ImageContainer *	myImagePtr
	Alias on the image container.

Private Member Functions
	ImageFactoryFromImage (const ImageFactoryFromImage &other)

ImageFactoryFromImage &	operator= (const ImageFactoryFromImage &other)

Detailed Description

template<typename TImageContainer>
class DGtal::ImageFactoryFromImage< TImageContainer >

Aim: implements a factory to produce images from a "bigger/original" one according to a given domain.

Description of template class 'ImageFactoryFromImage'

Template Parameters

TImageContainer an image container type (model of CImage).

The factory images production (images are copied, so it's a creation process) is done with the function 'requestImage' so the deletion must be done with the function 'detachImage'.

The update of the original image is done with the function 'flushImage'.

Examples: images/exampleImageFactoryFromHDF5.cpp, and images/exampleTiledImage.cpp.

Definition at line 66 of file ImageFactoryFromImage.h.

Member Typedef Documentation

◆ Domain

template<typename TImageContainer >

typedef ImageContainer::Domain DGtal::ImageFactoryFromImage< TImageContainer >::Domain

Definition at line 79 of file ImageFactoryFromImage.h.

◆ ImageContainer

template<typename TImageContainer >

typedef TImageContainer DGtal::ImageFactoryFromImage< TImageContainer >::ImageContainer

Types copied from the container.

Definition at line 78 of file ImageFactoryFromImage.h.

◆ OutputImage

template<typename TImageContainer >

typedef ImageContainer DGtal::ImageFactoryFromImage< TImageContainer >::OutputImage

New types.

Definition at line 82 of file ImageFactoryFromImage.h.

◆ Self

template<typename TImageContainer >

typedef ImageFactoryFromImage<TImageContainer> DGtal::ImageFactoryFromImage< TImageContainer >::Self

Definition at line 72 of file ImageFactoryFromImage.h.

Constructor & Destructor Documentation

◆ ImageFactoryFromImage() [1/2]

template<typename TImageContainer >

DGtal::ImageFactoryFromImage< TImageContainer >::ImageFactoryFromImage ( Alias< ImageContainer > anImage )

inline

Constructor.

Parameters

anImage alias on the underlying image container.

Definition at line 92 of file ImageFactoryFromImage.h.

                                                        :
      myImagePtr(&anImage)
    {
    }

◆ ~ImageFactoryFromImage()

template<typename TImageContainer >

DGtal::ImageFactoryFromImage< TImageContainer >::~ImageFactoryFromImage ( )

inline

Destructor. Does nothing

Definition at line 101 of file ImageFactoryFromImage.h.

101{}

◆ ImageFactoryFromImage() [2/2]

template<typename TImageContainer >

DGtal::ImageFactoryFromImage< TImageContainer >::ImageFactoryFromImage ( const ImageFactoryFromImage< TImageContainer > & other )

private

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

template<typename TImageContainer >

DGtal::ImageFactoryFromImage< TImageContainer >::BOOST_CONCEPT_ASSERT ( (concepts::CImage< TImageContainer >) )

Checking concepts.

◆ detachImage()

template<typename TImageContainer >

void DGtal::ImageFactoryFromImage< TImageContainer >::detachImage ( OutputImage * outputImage )

inline

Free (i.e. delete) an OutputImage.

Parameters

outputImage the OutputImage.

Definition at line 185 of file ImageFactoryFromImage.h.

    {
      delete outputImage;
    }

◆ domain()

template<typename TImageContainer >

const Domain & DGtal::ImageFactoryFromImage< TImageContainer >::domain ( ) const

inline

Returns a reference to the underlying image domain.

Returns: a reference to the domain.

Definition at line 119 of file ImageFactoryFromImage.h.

    {
        return myImagePtr->domain();
    }

References DGtal::ImageContainerBySTLVector< TDomain, TValue >::domain(), and DGtal::ImageFactoryFromImage< TImageContainer >::myImagePtr.

◆ flushImage()

template<typename TImageContainer >

void DGtal::ImageFactoryFromImage< TImageContainer >::flushImage ( OutputImage * outputImage )

inline

Flush (i.e. write/synchronize) an OutputImage.

Parameters

outputImage the OutputImage.

Definition at line 170 of file ImageFactoryFromImage.h.

    {
      typename Domain::Iterator it = outputImage->domain().begin();
      typename Domain::Iterator it_end = outputImage->domain().end();
      for (; it != it_end; ++it)
      {
        myImagePtr->setValue(*it, (*outputImage)(*it));
      }
    }

References DGtal::ImageContainerBySTLVector< TDomain, TValue >::domain(), DGtal::ImageFactoryFromImage< TImageContainer >::myImagePtr, and DGtal::ImageContainerBySTLVector< TDomain, TValue >::setValue().

◆ isValid()

template<typename TImageContainer >

bool DGtal::ImageFactoryFromImage< TImageContainer >::isValid ( ) const

inline

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

Definition at line 139 of file ImageFactoryFromImage.h.

    {
      return (myImagePtr->isValid());
    }

References DGtal::ImageContainerBySTLVector< TDomain, TValue >::isValid(), and DGtal::ImageFactoryFromImage< TImageContainer >::myImagePtr.

◆ operator=()

template<typename TImageContainer >

ImageFactoryFromImage & DGtal::ImageFactoryFromImage< TImageContainer >::operator= ( const ImageFactoryFromImage< TImageContainer > & other )

private

◆ requestImage()

template<typename TImageContainer >

OutputImage * DGtal::ImageFactoryFromImage< TImageContainer >::requestImage ( const Domain & aDomain )

inline

Returns a pointer of an OutputImage created with the Domain aDomain.

Parameters

aDomain the domain.

Returns: an ImagePtr.

Definition at line 151 of file ImageFactoryFromImage.h.

    {
      OutputImage* outputImage = new OutputImage(aDomain);
      
      typename Domain::Iterator it = outputImage->domain().begin();
      typename Domain::Iterator it_end = outputImage->domain().end();
      for (; it != it_end; ++it)
      {
        outputImage->setValue(*it, (*myImagePtr)(*it));
      }
        
      return outputImage;
    }

References DGtal::ImageContainerBySTLVector< TDomain, TValue >::domain(), DGtal::ImageFactoryFromImage< TImageContainer >::myImagePtr, and DGtal::ImageContainerBySTLVector< TDomain, TValue >::setValue().

◆ selfDisplay()

template<typename TImageContainer >

void DGtal::ImageFactoryFromImage< TImageContainer >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

Field Documentation

◆ myImagePtr

template<typename TImageContainer >

ImageContainer* DGtal::ImageFactoryFromImage< TImageContainer >::myImagePtr

protected

Alias on the image container.

Default constructor.

Definition at line 201 of file ImageFactoryFromImage.h.

Referenced by DGtal::ImageFactoryFromImage< TImageContainer >::domain(), DGtal::ImageFactoryFromImage< TImageContainer >::flushImage(), DGtal::ImageFactoryFromImage< TImageContainer >::isValid(), and DGtal::ImageFactoryFromImage< TImageContainer >::requestImage().

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

ImageFactoryFromImage.h

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

◆ Domain

◆ ImageContainer

◆ OutputImage

◆ Self

Constructor & Destructor Documentation

◆ ImageFactoryFromImage() [1/2]

◆ ~ImageFactoryFromImage()

◆ ImageFactoryFromImage() [2/2]

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

◆ detachImage()

◆ domain()

◆ flushImage()

◆ isValid()

◆ operator=()

◆ requestImage()

◆ selfDisplay()

Field Documentation

◆ myImagePtr