DGtal: DGtal::Viewer3D< TSpace, TKSpace >::TextureImage Struct Reference

#include <DGtal/io/viewers/Viewer3D.h>

Public Member Functions
	~TextureImage ()
	the mode of representation of the image More...

	TextureImage (const TextureImage &img)
	Copy constructor (needed due to myTabImage) More...

template<typename TImageType , typename TFunctor >
	TextureImage (const TImageType &image, const TFunctor &aFunctor, ImageDirection normalDir=zDirection, double xBottomLeft=0.0, double yBottomLeft=0.0, double zBottomLeft=0.0, TextureMode aMode=GrayScaleMode)

void	updateImageOrientation (ImageDirection normalDir, double xBottomLeft, double yBottomLeft, double zBottomLeft)

void	updateImage3DEmbedding (RealPoint aPoint1, RealPoint aPoint2, RealPoint aPoint3, RealPoint aPoint4)

template<typename TImageType , typename TFunctor >
void	updateImageDataAndParam (const TImageType &image, const TFunctor &aFunctor, double xTranslation=0.0, double yTranslation=0.0, double zTranslation=0.0)

std::string	className () const

Data Fields
RealPoint	point1

RealPoint	point2

RealPoint	point3

RealPoint	point4

ImageDirection	myDirection

unsigned int	myImageWidth
	direction of the image (x, y or z axe) More...

unsigned int	myImageHeight
	the width of the image More...

unsigned int *	myTabImage
	the height of the image More...

bool	myDrawDomain
	for each pixel of the image, color or height ? More...

unsigned int	myIndexDomain
	true if the draw have a domain More...

TextureMode	myMode
	index of the image domain if exist More...

Private Member Functions
	TextureImage ()

Detailed Description

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
struct DGtal::Viewer3D< TSpace, TKSpace >::TextureImage

Used to display an image as a textured quad image.

Definition at line 565 of file Viewer3D.h.

Constructor & Destructor Documentation

◆ ~TextureImage()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::~TextureImage ( )

inline

the mode of representation of the image

Destructor

Definition at line 587 of file Viewer3D.h.

       {
         delete [] myTabImage;
       };

References DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myTabImage.

◆ TextureImage() [1/3]

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage ( const TextureImage & img )

inline

Copy constructor (needed due to myTabImage)

Parameters

img the image

Definition at line 596 of file Viewer3D.h.

                                             : point1(img.point1), point2(img.point2),
                 point3(img.point3), point4(img.point4),
                 myDirection(img.myDirection), myImageWidth(img.myImageWidth),
                 myImageHeight(img.myImageHeight),
                 myTabImage(img.myTabImage),
                 myDrawDomain(img.myDrawDomain),
                 myIndexDomain(img.myIndexDomain),
                 myMode(img.myMode)
       {
  
         if(img.myImageHeight>0 && img.myImageWidth>0)
           {
             myTabImage = new unsigned int [img.myImageWidth*img.myImageHeight];
             for(unsigned int i=0; i<img.myImageWidth*img.myImageHeight; i++)
               {
                 myTabImage[i] = img.myTabImage[i];
               }
           }else
           {
             myTabImage=img.myTabImage;
           }
       };

References DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myTabImage.

◆ TextureImage() [2/3]

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

template<typename TImageType , typename TFunctor >

DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage	(	const TImageType &	image,
		const TFunctor &	aFunctor,
		ImageDirection	normalDir = `zDirection`,
		double	xBottomLeft = `0.0`,
		double	yBottomLeft = `0.0`,
		double	zBottomLeft = `0.0`,
		TextureMode	aMode = `GrayScaleMode`
	)

inline

Constructor that fills image parameters from std image (image buffer, dimensions, vertex coordinates, orientation)

Template Parameters

TImageType	the type of the image given for the constructor (should follow the CConstImage concept).
TFunctor	the functor type (should follow the CUnaryFunctor concept with image value type as input type and unsigned int as output type).

Parameters

image	the source image.
aFunctor	a functor to transform input values to the output displayed values.
normalDir	the direction of normal vector of the image plane (xDirection, yDirection or zDirection (default)) .
xBottomLeft	the x coordinate of bottom left image point (default 0).
yBottomLeft	the x coordinate of bottom left image point (default 0).
zBottomLeft	the x coordinate of bottom left image point (default 0).
aMode	the mode of representation (default GrayScaleMode).

Definition at line 642 of file Viewer3D.h.

       {
         BOOST_CONCEPT_ASSERT(( concepts::CConstImage < TImageType > ));
         BOOST_CONCEPT_ASSERT(( concepts::CUnaryFunctor<TFunctor, typename TImageType::Value, unsigned int> )) ;
         myDrawDomain=false;
         myDirection=normalDir;
         myImageWidth = (image.domain().upperBound())[0]-(image.domain().lowerBound())[0]+1;
         myImageHeight = (image.domain().upperBound())[1]-(image.domain().lowerBound())[1]+1;
         myTabImage = new unsigned int [myImageWidth*myImageHeight];
         updateImageOrientation(normalDir, xBottomLeft, yBottomLeft, zBottomLeft);
         myMode=aMode;
         updateImageDataAndParam(image, aFunctor);
       }

◆ TextureImage() [3/3]

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage ( )

inlineprivate

default constructor TextureImage

Definition at line 738 of file Viewer3D.h.

739 {};

Member Function Documentation

◆ className()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

std::string DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::className ( ) const

return the class name to implement the CDrawableWithViewer3D concept.

◆ updateImage3DEmbedding()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

void DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding	(	RealPoint	aPoint1,
		RealPoint	aPoint2,
		RealPoint	aPoint3,
		RealPoint	aPoint4
	)

inline

Update the embedding of the image by updating the image 3D vertex.

Parameters

aPoint1	the first image point (lower bound point)
aPoint2	the second image point (upper bound point in first dimension and lower in the second dimentsion)
aPoint3	the third image point (upper bound point in first second dimentsion)
aPoint4	the fourth image point (lower bound point in first dimension and upper in the second dimentsion)

Definition at line 680 of file Viewer3D.h.

       {
         point1 = aPoint1;  point2 = aPoint2; point3 = aPoint3;   point4 = aPoint4;
         myDirection=undefDirection;
       }

References DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myDirection, DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point1, DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point2, DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point3, DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point4, and DGtal::Viewer3D< TSpace, TKSpace >::undefDirection.

◆ updateImageDataAndParam()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

template<typename TImageType , typename TFunctor >

void DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam	(	const TImageType &	image,
		const TFunctor &	aFunctor,
		double	xTranslation = `0.0`,
		double	yTranslation = `0.0`,
		double	zTranslation = `0.0`
	)

inline

Update the image parameters from std image (image buffer, vertex coordinates) The new image should be with same dimension than the original.

Template Parameters

TImageType	the type of the image given for the constructor (should follow the CConstImage concept).
TFunctor	the functor type (should follow the CUnaryFunctor concept with image value type as input type and unsigned int as output type).

Parameters

image	the source image.
aFunctor	a functor to transform input values to the output displayed values.
xTranslation	the image translation in the x direction (default 0).
yTranslation	the image translation in the y direction (default 0).
zTranslation	the image translation in the z direction (default 0).

Definition at line 706 of file Viewer3D.h.

       {
         BOOST_CONCEPT_ASSERT(( concepts::CConstImage < TImageType > ));
         BOOST_CONCEPT_ASSERT(( concepts::CUnaryFunctor<TFunctor, typename TImageType::Value, unsigned int> )) ;
         assert ( (image.domain().upperBound())[0]-(image.domain().lowerBound())[0]+1== static_cast<int>(myImageWidth) &&
                  (image.domain().upperBound())[1]-(image.domain().lowerBound())[1]+1== static_cast<int>(myImageHeight));
  
         point1[0] += xTranslation; point1[1] += yTranslation; point1[2] += zTranslation;
         point2[0] += xTranslation; point2[1] +=yTranslation; point2[2] += zTranslation;
         point3[0] += xTranslation; point3[1] += yTranslation; point3[2] += zTranslation;
         point4[0] += xTranslation; point4[1] += yTranslation; point4[2] += zTranslation;
  
         unsigned int pos=0;
         for(typename TImageType::Domain::ConstIterator it = image.domain().begin(), itend=image.domain().end();
             it!=itend; ++it)
           {
             myTabImage[pos]= aFunctor(image(*it));
             pos++;
           }
       }

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage().

◆ updateImageOrientation()

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

void DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageOrientation	(	ImageDirection	normalDir,
		double	xBottomLeft,
		double	yBottomLeft,
		double	zBottomLeft
	)

Update the image direction from a specific normal direction (Viewer3D::xDirection, Viewer3D::yDirection or Viewer3D::zDirection) and image position from the botton left point.

Parameters

normalDir	give a predifined normal orientation can be (Viewer3D::xDirection, Viewer3D::yDirection or Viewer3D::zDirection)
xBottomLeft	the x coordinate of bottom left image point.
yBottomLeft	the x coordinate of bottom left image point.
zBottomLeft	the x coordinate of bottom left image point.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage().

Field Documentation

◆ myDirection

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

ImageDirection DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myDirection

Definition at line 573 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding().

◆ myDrawDomain

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

bool DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myDrawDomain

for each pixel of the image, color or height ?

Definition at line 580 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage().

◆ myImageHeight

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

unsigned int DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myImageHeight

the width of the image

Definition at line 576 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

◆ myImageWidth

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

unsigned int DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myImageWidth

direction of the image (x, y or z axe)

Definition at line 575 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

◆ myIndexDomain

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

unsigned int DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myIndexDomain

true if the draw have a domain

Definition at line 581 of file Viewer3D.h.

◆ myMode

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

TextureMode DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myMode

index of the image domain if exist

Definition at line 582 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage().

◆ myTabImage

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

unsigned int* DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myTabImage

the height of the image

Definition at line 578 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage(), DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::~TextureImage().

◆ point1

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

RealPoint DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point1

Definition at line 568 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

◆ point2

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

RealPoint DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point2

Definition at line 569 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

◆ point3

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

RealPoint DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point3

Definition at line 570 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

◆ point4

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>

RealPoint DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point4

Definition at line 571 of file Viewer3D.h.

Referenced by DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImage3DEmbedding(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam().

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

Viewer3D.h

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>> struct DGtal::Viewer3D< TSpace, TKSpace >::TextureImage

Constructor & Destructor Documentation

◆ ~TextureImage()

◆ TextureImage() [1/3]

◆ TextureImage() [2/3]

◆ TextureImage() [3/3]

Member Function Documentation

◆ className()

◆ updateImage3DEmbedding()

◆ updateImageDataAndParam()

◆ updateImageOrientation()

Field Documentation

◆ myDirection

◆ myDrawDomain

◆ myImageHeight

◆ myImageWidth

◆ myIndexDomain

◆ myMode

◆ myTabImage

◆ point1

◆ point2

◆ point3

◆ point4

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
struct DGtal::Viewer3D< TSpace, TKSpace >::TextureImage