Base class for user image accessors. More...

#include <BaseUserImageAccessor.h>

Inheritance diagram for ipsdk::image::BaseUserImageAccessor:

Public Member Functions
const std::string &	getImageName () const
	retrieve user image name (or identifier) More...

Constructors and destructors
	BaseUserImageAccessor ()

virtual	~BaseUserImageAccessor ()=0


const void *	getDataPtr (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const
	retrieve data pointer More...

const void *	getDataPtr (const PlanIndex &planIdx) const
	retrieve data pointer More...

void *	getDataPtr (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx)
	retrieve data pointer More...

void *	getDataPtr (const PlanIndex &planIdx)
	retrieve data pointer More...

Public Member Functions inherited from ipsdk::image::BaseImageAccessor
bool	isInit () const
	retrieve object initialisation flag

const eImageAccessMode &	getAccessMode () const
	retrieve user image access mode More...

const BaseImageGeometry &	getGeometry () const
	retrieve geometry associated to image file More...

const GeometricCalibrationConstPtr &	getGeometricCalibrationConstPtr () const
	retrieve geometric calibration associated to image More...

virtual bool	hasBinary8BitsStorage () const =0
	method allowing to check whether image underlying storage stores binary data with a 8 bit alignment More...

BoolResult	resize (const BaseImageGeometry &imageGeometry)
	resize image file given a geometry More...

void	clear ()
	clear of object data

	BaseImageAccessor ()

virtual	~BaseImageAccessor ()=0

bool	isValidPlanIdx (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const

bool	isValidPlanIdx (const PlanIndex &planIdx) const

BoolResult	readRaw (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 pixelStartOffset, const ipUInt64 nbPixels, void *pData) const
	read raw data segment from file More...

BoolResult	readRaw (const PlanIndex &planIdx, const ipUInt64 pixelStartOffset, const ipUInt64 nbPixels, void *pData) const
	read raw data segment from file More...

BoolResult	writeRaw (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 pixelStartOffset, const ipUInt64 nbPixels, const void *pData)
	write raw data segment to file More...

BoolResult	writeRaw (const PlanIndex &planIdx, const ipUInt64 pixelStartOffset, const ipUInt64 nbPixels, const void *pData)
	write raw data segment to file 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 BaseDynamicObject *	createNew () 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 BaseDynamicObject *	duplicate () 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

Protected Member Functions
std::string	getImageInfoStr () const
	retrieve image information string in derived class More...

void	initBase (const std::string &imageName, const eImageAccessMode &accessMode, const BaseImageGeometry &geometry, const GeometricCalibrationConstPtr &pGeometricCalibration)
	base class initialization method More...

virtual const void *	getDataPtrDerived (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const
	retrieve data pointer in derived class More...

virtual void *	getDataPtrDerived (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx)

virtual BoolResult	readRawData (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 pixelsStartOffset, const ipUInt64 nbPixels, void *pData) const
	read row data segment from user image More...

virtual BoolResult	writeRawData (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 pixelsStartOffset, const ipUInt64 nbPixels, const void *pData)
	write row data segment to user image More...

Protected Member Functions inherited from ipsdk::image::BaseImageAccessor
ImageGeometryPtr	getGeometryPtr ()
	retrieve geometry pointer associated to user image More...

void	initBase (const eImageAccessMode &accessMode, const BaseImageGeometry &geometry, const GeometricCalibrationConstPtr &pGeometricCalibration)
	base class initialization method More...

virtual BoolResult	resizeData (const BaseImageGeometry &geometry)=0
	resize user image given a geometry More...

virtual void	clearDerived ()=0
	clear 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

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 Attributes inherited from ipsdk::image::BaseImageAccessor
eImageAccessMode	_accessMode
	file access mode associated to manager

ImageGeometryPtr	_pGeometry
	geometry associated to file

GeometricCalibrationConstPtr	_pGeometricCalibration
	geometric calibration associated to image

bool	_bInit
	object initialization flag

Detailed Description

Base class for user image accessors.

Author: E. Noirfalise

Date: 2013/8/29

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getImageName()

const std::string& ipsdk::image::BaseUserImageAccessor::getImageName ( ) const

retrieve user image name (or identifier)

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

◆ getDataPtr() [1/4]

const void* ipsdk::image::BaseUserImageAccessor::getDataPtr	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx
	)		const

retrieve data pointer

Note: derived class without data direct access should not instanciate these methods

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

Returns: 0 if data pointer is not available

◆ getDataPtr() [2/4]

const void* ipsdk::image::BaseUserImageAccessor::getDataPtr ( const PlanIndex & planIdx ) const

retrieve data pointer

Note: derived class without data direct access should not instanciate these methods

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

Returns: 0 if data pointer is not available

◆ getDataPtr() [3/4]

void* ipsdk::image::BaseUserImageAccessor::getDataPtr	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx
	)

retrieve data pointer

Note: derived class without data direct access should not instanciate these methods

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

Returns: 0 if data pointer is not available

◆ getDataPtr() [4/4]

void* ipsdk::image::BaseUserImageAccessor::getDataPtr ( const PlanIndex & planIdx )

retrieve data pointer

Note: derived class without data direct access should not instanciate these methods

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

Returns: 0 if data pointer is not available

◆ getImageInfoStr()

std::string ipsdk::image::BaseUserImageAccessor::getImageInfoStr ( ) const

protectedvirtual

retrieve image information string in derived class

Exceptions

ipsdk::image::IPSDKImageException if isInit() == false

Implements ipsdk::image::BaseImageAccessor.

◆ initBase()

void ipsdk::image::BaseUserImageAccessor::initBase	(	const std::string &	imageName,
		const eImageAccessMode &	accessMode,
		const BaseImageGeometry &	geometry,
		const GeometricCalibrationConstPtr &	pGeometricCalibration
	)

protected

base class initialization method

Parameters

imageName	user image name (or identifier)
accessMode	read/write/resize access mode for user image
geometry	underlying geometry for image

◆ getDataPtrDerived()

virtual const void* ipsdk::image::BaseUserImageAccessor::getDataPtrDerived	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx
	)		const

protectedvirtual

retrieve data pointer in derived class

Note: derived class without data direct access should not instanciate these methods

Returns: 0 if data pointer is not available

◆ readRawData()

virtual BoolResult ipsdk::image::BaseUserImageAccessor::readRawData	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx,
		const ipUInt64	pixelsStartOffset,
		const ipUInt64	nbPixels,
		void *	pData
	)		const

protectedvirtual

read row data segment from user image

Parameters

zPlanIdx	z plan index for data access
cPlanIdx	c plan index for data access
tPlanIdx	t plan index for data access
pixelsStartOffset	pixel start offset for data in user image
nbPixels	number of pixels to be processed
pData	pointer to buffer filed from user image data

Note: this method should be reimplemented in derived classes in casee where getDataPtr(zPlanIdx, cPlanIdx, tPlanIdx) == 0

Exceptions

ipsdk::image::IPSDKImageException if getDataPtr(zPlanIdx, cPlanIdx, tPlanIdx) == 0

Implements ipsdk::image::BaseImageAccessor.

◆ writeRawData()

virtual BoolResult ipsdk::image::BaseUserImageAccessor::writeRawData	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx,
		const ipUInt64	pixelsStartOffset,
		const ipUInt64	nbPixels,
		const void *	pData
	)

protectedvirtual

write row data segment to user image

Parameters

zPlanIdx	z plan index for data access
cPlanIdx	c plan index for data access
tPlanIdx	t plan index for data access
pixelsStartOffset	pixel start offset for data in user image
nbPixels	number of pixels to be processed
pData	pointer to buffer used to write user image data

Note: this method should be reimplemented in derived classes in casee where getDataPtr(zPlanIdx, cPlanIdx, tPlanIdx) == 0

Exceptions

ipsdk::image::IPSDKImageException if getDataPtr(zPlanIdx, cPlanIdx, tPlanIdx) == 0

Implements ipsdk::image::BaseImageAccessor.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImage/Accessor/BaseUserImageAccessor.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getImageName()

◆ getDataPtr() [1/4]

◆ getDataPtr() [2/4]

◆ getDataPtr() [3/4]

◆ getDataPtr() [4/4]

◆ getImageInfoStr()

◆ initBase()

◆ getDataPtrDerived()

◆ readRawData()

◆ writeRawData()