DGtal  0.9.4beta
Public Member Functions | Data Fields | Private Member Functions
DGtal::Viewer3D< TSpace, TKSpace >::TextureImage Struct Reference

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

Collaboration diagram for DGtal::Viewer3D< TSpace, TKSpace >::TextureImage:
[legend]

Public Member Functions

 ~TextureImage ()
 
 TextureImage (const TextureImage &img)
 
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
 
unsigned int myImageHeight
 
unsigned int * myTabImage
 
bool myDrawDomain
 
unsigned int myIndexDomain
 
TextureMode myMode
 

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 564 of file Viewer3D.h.

Constructor & Destructor Documentation

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 586 of file Viewer3D.h.

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

587  {
588  delete [] myTabImage;
589  };
unsigned int * myTabImage
the height of the image
Definition: Viewer3D.h:577
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
imgthe image

Definition at line 595 of file Viewer3D.h.

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

595  : point1(img.point1), point2(img.point2),
596  point3(img.point3), point4(img.point4),
597  myDirection(img.myDirection), myImageWidth(img.myImageWidth),
598  myImageHeight(img.myImageHeight),
599  myTabImage(img.myTabImage),
600  myDrawDomain(img.myDrawDomain),
601  myIndexDomain(img.myIndexDomain),
602  myMode(img.myMode)
603  {
604 
605  if(img.myImageHeight>0 && img.myImageWidth>0)
606  {
607  myTabImage = new unsigned int [img.myImageWidth*img.myImageHeight];
608  for(unsigned int i=0; i<img.myImageWidth*img.myImageHeight; i++)
609  {
610  myTabImage[i] = img.myTabImage[i];
611  }
612  }else
613  {
614  myTabImage=img.myTabImage;
615  }
616  };
ImageDirection myDirection
Definition: Viewer3D.h:572
unsigned int myIndexDomain
true if the draw have a domain
Definition: Viewer3D.h:580
TextureMode myMode
index of the image domain if exist
Definition: Viewer3D.h:581
unsigned int myImageHeight
the width of the image
Definition: Viewer3D.h:575
unsigned int myImageWidth
direction of the image (x, y or z axe)
Definition: Viewer3D.h:574
unsigned int * myTabImage
the height of the image
Definition: Viewer3D.h:577
bool myDrawDomain
for each pixel of the image, color or height ?
Definition: Viewer3D.h:579
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
TImageTypethe type of the image given for the constructor (should follow the CConstImage concept).
TFunctorthe functor type (should follow the CUnaryFunctor concept with image value type as input type and unsigned int as output type).
Parameters
imagethe source image.
aFunctora functor to transform input values to the output displayed values.
normalDirthe direction of normal vector of the image plane (xDirection, yDirection or zDirection (default)) .
xBottomLeftthe x coordinate of bottom left image point (default 0).
yBottomLeftthe x coordinate of bottom left image point (default 0).
zBottomLeftthe x coordinate of bottom left image point (default 0).
aModethe mode of representation (default GrayScaleMode).

Definition at line 641 of file Viewer3D.h.

References DGtal::Viewer3D< TSpace, TKSpace >::BOOST_CONCEPT_ASSERT(), DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myImageHeight, DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageDataAndParam(), and DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::updateImageOrientation().

645  {
646  BOOST_CONCEPT_ASSERT(( concepts::CConstImage < TImageType > ));
647  BOOST_CONCEPT_ASSERT(( concepts::CUnaryFunctor<TFunctor, typename TImageType::Value, unsigned int> )) ;
648  myDrawDomain=false;
649  myDirection=normalDir;
650  myImageWidth = (image.domain().upperBound())[0]-(image.domain().lowerBound())[0]+1;
651  myImageHeight = (image.domain().upperBound())[1]-(image.domain().lowerBound())[1]+1;
652  myTabImage = new unsigned int [myImageWidth*myImageHeight];
653  updateImageOrientation(normalDir, xBottomLeft, yBottomLeft, zBottomLeft);
654  myMode=aMode;
655  updateImageDataAndParam(image, aFunctor);
656  }
ImageDirection myDirection
Definition: Viewer3D.h:572
void updateImageOrientation(ImageDirection normalDir, double xBottomLeft, double yBottomLeft, double zBottomLeft)
TextureMode myMode
index of the image domain if exist
Definition: Viewer3D.h:581
unsigned int myImageHeight
the width of the image
Definition: Viewer3D.h:575
unsigned int myImageWidth
direction of the image (x, y or z axe)
Definition: Viewer3D.h:574
BOOST_CONCEPT_ASSERT((concepts::CSpace< TSpace >))
unsigned int * myTabImage
the height of the image
Definition: Viewer3D.h:577
void updateImageDataAndParam(const TImageType &image, const TFunctor &aFunctor, double xTranslation=0.0, double yTranslation=0.0, double zTranslation=0.0)
Definition: Viewer3D.h:705
bool myDrawDomain
for each pixel of the image, color or height ?
Definition: Viewer3D.h:579
template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::TextureImage ( )
inlineprivate

default constructor TextureImage

Definition at line 737 of file Viewer3D.h.

738  {};

Member Function Documentation

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.

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
aPoint1the first image point (lower bound point)
aPoint2the second image point (upper bound point in first dimension and lower in the second dimentsion)
aPoint3the third image point (upper bound point in first second dimentsion)
aPoint4the fourth image point (lower bound point in first dimension and upper in the second dimentsion)

Definition at line 679 of file Viewer3D.h.

References DGtal::Viewer3D< TSpace, TKSpace >::undefDirection.

683  {
684  point1 = aPoint1; point2 = aPoint2; point3 = aPoint3; point4 = aPoint4;
686  }
ImageDirection myDirection
Definition: Viewer3D.h:572
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
TImageTypethe type of the image given for the constructor (should follow the CConstImage concept).
TFunctorthe functor type (should follow the CUnaryFunctor concept with image value type as input type and unsigned int as output type).
Parameters
imagethe source image.
aFunctora functor to transform input values to the output displayed values.
xTranslationthe image translation in the x direction (default 0).
yTranslationthe image translation in the y direction (default 0).
zTranslationthe image translation in the z direction (default 0).

Definition at line 705 of file Viewer3D.h.

References DGtal::Viewer3D< TSpace, TKSpace >::BOOST_CONCEPT_ASSERT().

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

707  {
708  BOOST_CONCEPT_ASSERT(( concepts::CConstImage < TImageType > ));
709  BOOST_CONCEPT_ASSERT(( concepts::CUnaryFunctor<TFunctor, typename TImageType::Value, unsigned int> )) ;
710  assert ( (image.domain().upperBound())[0]-(image.domain().lowerBound())[0]+1== static_cast<int>(myImageWidth) &&
711  (image.domain().upperBound())[1]-(image.domain().lowerBound())[1]+1== static_cast<int>(myImageHeight));
712 
713  point1[0] += xTranslation; point1[1] += yTranslation; point1[2] += zTranslation;
714  point2[0] += xTranslation; point2[1] +=yTranslation; point2[2] += zTranslation;
715  point3[0] += xTranslation; point3[1] += yTranslation; point3[2] += zTranslation;
716  point4[0] += xTranslation; point4[1] += yTranslation; point4[2] += zTranslation;
717 
718  unsigned int pos=0;
719  for(typename TImageType::Domain::ConstIterator it = image.domain().begin(), itend=image.domain().end();
720  it!=itend; ++it)
721  {
722  myTabImage[pos]= aFunctor(image(*it));
723  pos++;
724  }
725  }
unsigned int myImageHeight
the width of the image
Definition: Viewer3D.h:575
unsigned int myImageWidth
direction of the image (x, y or z axe)
Definition: Viewer3D.h:574
BOOST_CONCEPT_ASSERT((concepts::CSpace< TSpace >))
unsigned int * myTabImage
the height of the image
Definition: Viewer3D.h:577
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
normalDirgive a predifined normal orientation can be (Viewer3D::xDirection, Viewer3D::yDirection or Viewer3D::zDirection)
xBottomLeftthe x coordinate of bottom left image point.
yBottomLeftthe x coordinate of bottom left image point.
zBottomLeftthe x coordinate of bottom left image point.

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

Field Documentation

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

Definition at line 572 of file Viewer3D.h.

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 579 of file Viewer3D.h.

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 575 of file Viewer3D.h.

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

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 574 of file Viewer3D.h.

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

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 580 of file Viewer3D.h.

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 581 of file Viewer3D.h.

template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
unsigned int* DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::myTabImage
template<typename TSpace = SpaceND<3>, typename TKSpace = KhalimskySpaceND<3>>
RealPoint DGtal::Viewer3D< TSpace, TKSpace >::TextureImage::point1

Definition at line 567 of file Viewer3D.h.

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

Definition at line 568 of file Viewer3D.h.

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

Definition at line 569 of file Viewer3D.h.

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

Definition at line 570 of file Viewer3D.h.


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