IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Public Member Functions | List of all members
ipsdk::image::HomogeneousImageGeometry Class Reference

Image geometry associated to constant image buffer types through image plans. More...

#include <HomogeneousImageGeometry.h>

Inheritance diagram for ipsdk::image::HomogeneousImageGeometry:
ipsdk::image::BaseImageGeometry ipsdk::BaseSerializationObject ipsdk::BaseDynamicObject

Public Member Functions

eImageGeometryType getImageGeometryType () const
 retrieve image buffer type
 
void init (const VolumeGeometry &volumeGeometry, const ColorGeometry &colorGeometry, const TemporalGeometry &temporalGeometry, const ipUInt64 sizeX, const ipUInt64 sizeY, const eImageBufferType &imageBufferType)
 initialization of object More...
 
Constructors and destructors
 HomogeneousImageGeometry ()
 
 ~HomogeneousImageGeometry ()
 
- Public Member Functions inherited from ipsdk::image::BaseImageGeometry
bool isInit () const
 retrieve object initialisation flag
 
ipUInt64 getNbTotPlans () const
 retrieve total number of plans for geometry More...
 
bool isValidPixelIdx (const ipUInt64 x, const ipUInt64 y) const
 check whether a pixel index is valid given geometry More...
 
ipUInt64 getNbPixels () const
 retrieve total number of pixels associated to geometry More...
 
ipUInt64 getFullMemorySize () const
 retrieve total memory size associated to geometry (in octets) More...
 
const eImageBufferTypegetBufferType () const
 retrieve image data type More...
 
virtual const eImageBufferTypegetBufferType (const ipUInt64 tPlanIdx) const
 retrieve image data type for a given temporal plan More...
 
void resize (const VolumeGeometry &volumeGeometry, const ColorGeometry &colorGeometry, const TemporalGeometry &temporalGeometry, const ipUInt64 sizeX, const ipUInt64 sizeY)
 change image geometry dimensions More...
 
virtual void resize (const VolumeGeometry &volumeGeometry, const ColorGeometry &colorGeometry, const TemporalGeometry &temporalGeometry, const ipUInt64 sizeX, const ipUInt64 sizeY, const eImageBufferType &imageBufferType)
 change image geometry dimensions and image buffer type More...
 
virtual void setImageBufferType (const eImageBufferType &imageBufferType)
 change image buffer type associated to all plans More...
 
ImagePlanGeometry getPlanGeometry (const ipUInt64 tPlanIdx) const
 retrieve image plan geometry for a given plan More...
 
ipUInt64 getPlanNbPixels () const
 retrieve image plan number of pixels More...
 
ipUInt64 getPlanMemorySize (const ipUInt64 tPlanIdx=0) const
 retrieve image plan full memory size for a given plan More...
 
void clear ()
 clear object data
 
 BaseImageGeometry ()
 
virtual ~BaseImageGeometry ()=0
 
const VolumeGeometrygetVolumeGeometry () const
 retrieve volume geometry (z) More...
 
VolumeGeometrygetVolumeGeometry ()
 retrieve volume geometry (z) More...
 
const eVolumeGeometryTypegetVolumeGeometryType () const
 retrieve volume geometry (z) More...
 
ipUInt64 getSizeZ () const
 retrieve volume geometry (z) More...
 
const ColorGeometrygetColorGeometry () const
 retrieve color geometry (c) More...
 
ColorGeometrygetColorGeometry ()
 retrieve color geometry (c) More...
 
const eColorGeometryTypegetColorGeometryType () const
 retrieve color geometry (c) More...
 
ipUInt64 getSizeC () const
 retrieve color geometry (c) More...
 
const TemporalGeometrygetTemporalGeometry () const
 retrieve temporal geometry (t) More...
 
TemporalGeometrygetTemporalGeometry ()
 retrieve temporal geometry (t) More...
 
const eTemporalGeometryTypegetTemporalGeometryType () const
 retrieve temporal geometry (t) More...
 
ipUInt64 getSizeT () const
 retrieve temporal geometry (t) More...
 
ipUInt64 getSizeX () const
 retrieve image x and y plan size More...
 
ipUInt64 getSizeY () const
 retrieve image x and y plan size More...
 
bool isValidPlanIdx (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const
 check whether a plan index is valid given geometry More...
 
bool isValidPlanIdx (const PlanIndex &planIdx) const
 check whether a plan index is valid given geometry More...
 
void setVolumeGeometryType (const eVolumeGeometryType &vType)
 Setters of geometry types : More...
 
void setColorGeometryType (const eColorGeometryType &cType)
 Setters of geometry types : More...
 
void setTemporalGeometryType (const eTemporalGeometryType &tType)
 Setters of geometry types : More...
 
- Public Member Functions inherited from ipsdk::BaseSerializationObject
 BaseSerializationObject ()
 Default constructor.
 
virtual ~BaseSerializationObject ()=0
 destructor
 
- Public Member Functions inherited from ipsdk::BaseDynamicObject
virtual const std::string & getClassName () const
 method allowing to retrieve object class name
 
virtual BaseDynamicObjectcreateNew () const =0
 method allowing to create new instance of current object type
 
virtual DynamicObjectPtr createShared () const =0
 method allowing to create new shared instance of current object type
 
virtual bool hasCopySupport () const =0
 check whether objet has copy support
 
virtual BaseDynamicObjectduplicate () const =0
 method allowing to duplicate current object More...
 
virtual DynamicObjectPtr duplicateShared () const =0
 method allowing shared duplication of current object More...
 
 BaseDynamicObject ()
 
virtual ~BaseDynamicObject ()=0
 

Additional Inherited Members

- Static Public Member Functions inherited from ipsdk::BaseSerializationObject
static ipUInt32 getVersion ()
 method allowing to retrieve class version information for serialization
 
- Static Public Member Functions inherited from ipsdk::BaseDynamicObject
static const std::string & getTypeName ()
 method allowing to retrieve name associated to class
 
- Protected Member Functions inherited from ipsdk::image::BaseImageGeometry
void initBase (const VolumeGeometry &volumeGeometry, const ColorGeometry &colorGeometry, const TemporalGeometry &temporalGeometry, const ipUInt64 sizeX, const ipUInt64 sizeY, const eImageBufferType &imageBufferType)
 base class initialization method
 
virtual void clearDerived ()
 clear of object data in derived class
 
- Protected Member Functions inherited from ipsdk::BaseSerializationObject
virtual BoolResult write (BaseOArchive &ar) const
 method allowing to ensure serialization write part for object
 
virtual BoolResult read (BaseIArchive &ar)
 method allowing to ensure serialization read part for object
 
- Protected Member Functions inherited from ipsdk::BaseDynamicObject
virtual void initCtorCopy (const BaseDynamicObject &object)
 
virtual void copy (const BaseDynamicObject &object)
 method allowing to copy data from another object
 

Detailed Description

Image geometry associated to constant image buffer types through image plans.

Author
E. Noirfalise
Date
2014/06/06

Member Function Documentation

◆ init()

void ipsdk::image::HomogeneousImageGeometry::init ( const VolumeGeometry volumeGeometry,
const ColorGeometry colorGeometry,
const TemporalGeometry temporalGeometry,
const ipUInt64  sizeX,
const ipUInt64  sizeY,
const eImageBufferType imageBufferType 
)

initialization of object

Exceptions
ipsdk::image::IPSDKImageExceptionif imageBufferType == eImageBufferType::eIBT_None

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