SMIL  0.11.3-dev
BaseImage Class Referenceabstract

Base Image class. More...

Detailed Description

Base Image class.

#include <DBaseImage.h>

+ Inheritance diagram for BaseImage:
+ Collaboration diagram for BaseImage:

Public Member Functions

 BaseImage (const char *_className="BaseImage")
 
 BaseImage (const BaseImage &rhs)
 
BaseImageoperator= (const BaseImage &rhs)
 
virtual void init ()
 
size_t getWidth () const
 Get image width.
 
size_t getHeight () const
 Get image height.
 
size_t getDepth () const
 Get image depth (Z)
 
virtual size_t getAllocatedSize () const
 Get memory size (bytes)
 
UINT getDimension () const
 Get dimension (2D or 3D)
 
virtual RES_T setSize (size_t w, size_t h, size_t d=1, bool doAllocate=true)=0
 Set image size Set image size and allocate it if doAllocate is true.
 
void getSize (size_t *w, size_t *h, size_t *d) const
 Get image size.
 
void getSize (size_t s[3]) const
 Get image size.
 
void getSize (off_t s[3]) const
 Get image size.
 
void getSize (int s[3]) const
 Get image size.
 
size_t getPixelCount () const
 Get the number of pixels.
 
size_t getLineCount () const
 Get the number of lines.
 
size_t getSliceCount () const
 Get the number of slices(for 3D images)
 
bool isAllocated () const
 Check if the image is allocated.
 
virtual void * getVoidPointer ()=0
 Get the void* data array.
 
virtual void modified ()=0
 Trigger modified event.
 
virtual bool isCoordsInImage (const off_t x, const off_t y, const off_t z=0)
 isCoordsInImage() - checks if the triplet (x, y, z) in inside the image bounds. More...
 
virtual bool isCoordsInImage (const size_t x, const size_t y, const size_t z=0)
 isCoordsInImage() - checks if the triplet (x, y, z) in inside the image bounds. More...
 
virtual bool isOffsetInImage (const off_t offset)
 isCoordsInImage() - checks if a buffer offset in inside the image bounds. More...
 
virtual bool isOffsetInImage (const size_t offset)
 isCoordsInImage() - checks if a buffer offset in inside the image bounds. More...
 
off_t getOffsetFromCoords (size_t x, size_t y, size_t z=1) const
 Get an offset for given x,y(,z) coordinates.
 
void getCoordsFromOffset (size_t off, size_t &x, size_t &y, size_t &z) const
 Get x,y(,z) coordinates for a given offset.
 
void getCoordsFromOffset (off_t off, off_t &x, off_t &y, off_t &z) const
 Get x,y(,z) coordinates for a given offset.
 
virtual const char * getInfoString (const char *="") const
 Get the description of the image.
 
virtual const char * getTypeAsString ()=0
 Get the type of the image as a string ("UINT8",...)
 
virtual bool isVisible ()
 Check if the image (viewer) is visible.
 
virtual void show (const char *=NULL, bool=false)
 Show the image (viewer)
 
virtual void showLabel (const char *=NULL)
 Show the image (viewer) as false colors.
 
virtual void hide ()=0
 Hide the image (viewer)
 
virtual RES_T load (const char *)
 Load from file.
 
virtual RES_T save (const char *)
 Save to file.
 
virtual BaseImageViewergetViewer ()=0
 Get the viewer associated to the image.
 
- Public Member Functions inherited from BaseObject
 BaseObject (const char *_className, bool _register=true)
 
 BaseObject (const BaseObject &rhs, bool _register=true)
 
BaseObjectoperator= (const BaseObject &rhs)
 
CoregetCoreInstance ()
 
virtual void printSelf (ostream &=std::cout, string="") const
 
virtual const char * getClassName () const
 
virtual void setName (const char *_name)
 
virtual const char * getName () const
 

Public Attributes

bool updatesEnabled
 
Signal onModified
 
Signal onShow
 
- Public Attributes inherited from BaseObject
bool triggerEvents
 

Protected Attributes

size_t dataTypeSize
 
size_t width
 
size_t height
 
size_t depth
 
size_t pixelCount
 
size_t lineCount
 
size_t sliceCount
 
bool allocated
 
size_t allocatedSize
 
- Protected Attributes inherited from BaseObject
bool registered
 
string className
 
string name
 

Private Types

typedef BaseObject parentClass
 

Additional Inherited Members

- Public Types inherited from BaseObject
typedef void parentClass
 
typedef void(BaseObject::* voidMemberFunc) ()
 

Member Function Documentation

◆ isCoordsInImage() [1/2]

virtual bool isCoordsInImage ( const off_t  x,
const off_t  y,
const off_t  z = 0 
)
inlinevirtual

isCoordsInImage() - checks if the triplet (x, y, z) in inside the image bounds.

Parameters
[in]x,y,z: coords of a point

◆ isCoordsInImage() [2/2]

virtual bool isCoordsInImage ( const size_t  x,
const size_t  y,
const size_t  z = 0 
)
inlinevirtual

isCoordsInImage() - checks if the triplet (x, y, z) in inside the image bounds.

Parameters
[in]x,y,z: coords of a point

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

◆ isOffsetInImage() [1/2]

virtual bool isOffsetInImage ( const off_t  offset)
inlinevirtual

isCoordsInImage() - checks if a buffer offset in inside the image bounds.

Parameters
[in]offset: offset of a point in the image buffer

◆ isOffsetInImage() [2/2]

virtual bool isOffsetInImage ( const size_t  offset)
inlinevirtual

isCoordsInImage() - checks if a buffer offset in inside the image bounds.

Parameters
[in]offset: offset of a point in the image buffer

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