Class encapsulating python image plan data with data alignment. More...

#include <PythonAlignedPlanStorage.h>

Inheritance diagram for ipsdk::python::PythonAlignedPlanStorage:

Public Member Functions
image::ePlanStorageType	getPlanStorageType () const
	retrieve plan storage type

void	init (PythonImageAccessorPtr &pPythonImageAccessor, ipUInt64 zPlanIdx, ipUInt64 cPlanIdx, ipUInt64 tPlanIdx)
	storage initialization

const PythonImageAccessor &	getPythonImageAccessor () const
	retrieve image accessor More...

ipUInt64	getZPlanIdx () const
	retrieve z plan index for plan in full image More...

ipUInt64	getCPlanIdx () const
	retrieve c plan index for plan in full image More...

ipUInt64	getTPlanIdx () const
	retrieve t plan index for plan in full image More...

image::eImageAccessMode	getAccessMode () const
	retrieve image access mode More...

bool	canBeRemotlyAccessed () const
	retrieve flag indicating whether data can be remotly accessed More...

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

Constructors and destructors
	PythonAlignedPlanStorage ()

	~PythonAlignedPlanStorage ()

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

bool	hasFullDataAccess () const
	check whether object has a contiguous access to full plan data More...

virtual bool	hasRowDataAccess (const ipUInt64 startOffsetY, const ipUInt64 sizeY=1) const
	check whether object has a contiguous access to specific rows of data More...

BoolResult	resize (const ImagePlanGeometry &planGeometry)
	resize plan storage More...

virtual ipUInt64	getFullBufferSize () const
	retrieve full buffer size More...

void	clear ()
	clear object data

virtual ipBool	isDiskPlanStorage () const
	returns true if the plan storage is used for a disk image

	BasePlanStorage ()

virtual	~BasePlanStorage ()=0

const ImagePlanGeometry &	getPlanGeometry () const
	retrieve geometry associated to storage More...

ipUInt64	getSizeX () const
	retrieve geometry plan x size More...

ipUInt64	getSizeY () const
	retrieve geometry plan y size More...

ipUInt64	getNbPixels () const
	retrieve number of pixels inside geometry More...

const eImageBufferType &	getBufferType () const
	retrieve image data type More...

virtual const void *	getDataPtr () const
	retrieve data pointer More...

virtual void *	getDataPtr ()
	retrieve data pointer More...

virtual const void *	getRowDataPtr (const ipUInt64 offsetY) const
	retrieve a row data pointer More...

virtual void *	getRowDataPtr (const ipUInt64 offsetY)
	retrieve a row data pointer More...

BoolResult	readRaw (const ipUInt64 startOffset, const ipUInt64 size, void *pData) const
	method allowing to read data from image storage More...

BoolResult	readArea (const ipUInt64 areaStartOffsetX, const ipUInt64 areaSizeX, const ipUInt64 areaStartOffsetY, const BufferPtrColl &dataColl) const
	method allowing to read a rectangular area of data More...

BoolResult	writeRaw (const ipUInt64 startOffset, const ipUInt64 size, const void *pData)
	method allowing to write data to image storage More...

BoolResult	writeArea (const ipUInt64 areaStartOffsetX, const ipUInt64 areaSizeX, const ipUInt64 areaStartOffsetY, const BufferConstPtrColl &dataColl)
	method allowing to write a rectangular area of data More...

Public Member Functions inherited from ipsdk::BaseObjectWithSkeleton
const eSklSrzMode &	getSerializationMode () const
	retrieve serialization flag for object More...

void	setSerializationMode (const eSklSrzMode &sklSrzMode) const
	set serialization flag for object

	BaseObjectWithSkeleton ()

	~BaseObjectWithSkeleton ()

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
BoolResult	resizePlan (const image::ImagePlanGeometry &planGeometry)
	resize plan storage in derived class More...

BoolResult	readRawData (const ipUInt64 startOffset, const ipUInt64 size, void *pData) const
	method allowing to read data from image storage More...

BoolResult	writeRawData (const ipUInt64 startOffset, const ipUInt64 size, const void *pData)
	method allowing to write data to image storage More...

void	clearPlanData ()
	clear plan data in derived class

Protected Member Functions inherited from ipsdk::image::BasePlanStorage
void	initBase (const ImagePlanGeometry &planGeometry)
	base class initialization method

virtual BoolResult	readAreaData (const ipUInt64 areaStartOffsetX, const ipUInt64 areaSizeX, const ipUInt64 areaStartOffsetY, const BufferPtrColl &dataColl) const
	method allowing to read a rectangular area of data More...

virtual BoolResult	writeAreaData (const ipUInt64 areaStartOffsetX, const ipUInt64 areaSizeX, const ipUInt64 areaStartOffsetY, const BufferConstPtrColl &dataColl)
	method allowing to write a rectangular area of data More...

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

Protected Attributes
PythonImageAccessorPtr	_pPythonImageAccessor
	pointer to image file accessor

ipUInt64	_zPlanIdx
	z plan index for plan in full image

ipUInt64	_cPlanIdx
	c plan index for plan in full image

ipUInt64	_tPlanIdx
	t plan index for plan in full image

Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

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

Detailed Description

Class encapsulating python image plan data with data alignment.

Author: R. Abbal

Date: 2019/02/22

Copyright: 2019 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getPythonImageAccessor()

const PythonImageAccessor & PythonAlignedPlanStorage::getPythonImageAccessor ( ) const

retrieve image accessor

Exceptions

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

◆ getZPlanIdx()

ipUInt64 PythonAlignedPlanStorage::getZPlanIdx ( ) const

retrieve z plan index for plan in full image

Exceptions

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

◆ getCPlanIdx()

ipUInt64 PythonAlignedPlanStorage::getCPlanIdx ( ) const

retrieve c plan index for plan in full image

Exceptions

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

◆ getTPlanIdx()

ipUInt64 PythonAlignedPlanStorage::getTPlanIdx ( ) const

retrieve t plan index for plan in full image

Exceptions

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

◆ getAccessMode()

eImageAccessMode PythonAlignedPlanStorage::getAccessMode ( ) const

virtual

retrieve image access mode

Exceptions

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

Implements ipsdk::image::BasePlanStorage.

◆ canBeRemotlyAccessed()

bool PythonAlignedPlanStorage::canBeRemotlyAccessed ( ) const

virtual

retrieve flag indicating whether data can be remotly accessed

Exceptions

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

Implements ipsdk::image::BasePlanStorage.

◆ hasBinary8BitsStorage()

bool PythonAlignedPlanStorage::hasBinary8BitsStorage ( ) const

virtual

method allowing to check whether image underlying storage stores binary data with a 8 bit alignment

Exceptions

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

Implements ipsdk::image::BasePlanStorage.

◆ resizePlan()

BoolResult PythonAlignedPlanStorage::resizePlan ( const image::ImagePlanGeometry & planGeometry )

protectedvirtual

resize plan storage in derived class

Returns: false in case of failure

Implements ipsdk::image::BasePlanStorage.

◆ readRawData()

BoolResult PythonAlignedPlanStorage::readRawData	(	const ipUInt64	startOffset,
		const ipUInt64	size,
		void *	pData
	)		const

protectedvirtual

method allowing to read data from image storage

Returns: false in case of failure

Implements ipsdk::image::BasePlanStorage.

◆ writeRawData()

BoolResult PythonAlignedPlanStorage::writeRawData	(	const ipUInt64	startOffset,
		const ipUInt64	size,
		const void *	pData
	)

protectedvirtual

method allowing to write data to image storage

Exceptions

ipsdk::image::IPSDKImageException if getAccessMode() == eImageAccessMode::eIAM_Read

Returns: false in case of failure

Implements ipsdk::image::BasePlanStorage.

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/Python/PyIPSDKBase/PythonAlignedPlanStorage.h
/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/src/Python/PyIPSDKBase/PythonAlignedPlanStorage.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getPythonImageAccessor()

◆ getZPlanIdx()

◆ getCPlanIdx()

◆ getTPlanIdx()

◆ getAccessMode()

◆ canBeRemotlyAccessed()

◆ hasBinary8BitsStorage()

◆ resizePlan()

◆ readRawData()

◆ writeRawData()