Inheritance diagram for ipsdk::python::PythonImageAccessor:

Public Member Functions
void	init (const std::string &imageName, const ipsdk::image::eImageAccessMode &accessMode, const ipsdk::image::BaseImageGeometry &geometry, const ipsdk::GeometricCalibrationConstPtr pGeometricCalibration, const ipsdk::ipUInt64 sizeXAlign, void *pData)
	object initialization method More...

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

ipsdk::ipUInt64	getSizeXAlign ()
	returns the size along the x direction with alignment data

Constructors and destructors
	PythonImageAccessor ()

	~PythonImageAccessor ()

Public Member Functions inherited from ipsdk::image::BaseDiskImageAccessor
const boost::filesystem::path &	getFilePath () const
	retrieve file path associated to object More...

bool	hasSharedRemoteAccess () const
	retrieve flag indicating whether image has remote shared access (image can be accessed from every where on network) More...

	BaseDiskImageAccessor ()

virtual	~BaseDiskImageAccessor ()=0

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...

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
ipsdk::BoolResult	resizeData (const ipsdk::image::BaseImageGeometry &geometry)
	resize user image given a geometry More...

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

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

void	clearDerived ()
	clear data in derived class

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

void	initBase (const boost::filesystem::path &filePath, const eImageAccessMode &accessMode, const BaseImageGeometry &geometry, const GeometricCalibrationConstPtr &pGeometricCalibration, const bool bSharedRemoteAccess)
	base class initialization method More...

boost::filesystem::path	getNewDiskImagePath (const std::string strExtension, const BaseImageGeometry &geometry)
	Generates a file path with the default format: <PATH_TO_TEMPORARY_DISK_IMAGES>/IPSDK_Image_YYYYMMDD-HHMMSS.ext Where ext is the image extension and <PATH_TO_TEMPORARY_DISK_IMAGES> is defined in the local processing policy and equals C:<USER> on windows and /tmp/ReactivIP/IPSDK on Linux.

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...

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
void *	_pData
	pointer to first voxel of IPSDK image data

ipsdk::ipUInt8	_dataBaseSize
	data base size

ipsdk::ipUInt64	_planSizeAlign
	plan size (with the alignment data)

ipsdk::ipUInt64	_planSize
	plan size (without the alignment data)

ipsdk::ipUInt64	_sizeXAlign
	number of columns (with the alignment data)

ipsdk::ipUInt64	_sizeX
	number of columns (without the alignment data)

ipsdk::ipUInt64	_sizeY
	number of lines

ipsdk::ipUInt64	_sizeZ
	number of plans

ipsdk::ipUInt64	_sizeC
	number of color channels

ipsdk::ipUInt64	_sizeT
	number of frames

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

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

Member Function Documentation

◆ init()

void ipsdk::python::PythonImageAccessor::init	(	const std::string &	imageName,
		const ipsdk::image::eImageAccessMode &	accessMode,
		const ipsdk::image::BaseImageGeometry &	geometry,
		const ipsdk::GeometricCalibrationConstPtr	pGeometricCalibration,
		const ipsdk::ipUInt64	sizeXAlign,
		void *	pData
	)

object initialization method

Parameters

imageName	user image name (or identifier)
accessMode	read/write/resize access mode for user image
geometry	underlying geometry for image
pGeometricCalibration	underlying calibration geometry for image
sizeXAlign	image size along the x-axix tanking into account the alignment data
pData	data buffer

◆ hasBinary8BitsStorage()

bool ipsdk::python::PythonImageAccessor::hasBinary8BitsStorage ( ) const

inlinevirtual

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::BaseImageAccessor.

◆ resizeData()

ipsdk::BoolResult ipsdk::python::PythonImageAccessor::resizeData ( const ipsdk::image::BaseImageGeometry & geometry )

protectedvirtual

resize user image given a geometry

Returns: false in case of failure

Implements ipsdk::image::BaseImageAccessor.

◆ readRawData()

ipsdk::BoolResult ipsdk::python::PythonImageAccessor::readRawData	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx,
		const ipsdk::ipUInt64	pixelsStartOffset,
		const ipsdk::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

Implements ipsdk::image::BaseImageAccessor.

◆ writeRawData()

ipsdk::BoolResult ipsdk::python::PythonImageAccessor::writeRawData	(	const ipsdk::ipUInt64	zPlanIdx,
		const ipsdk::ipUInt64	cPlanIdx,
		const ipsdk::ipUInt64	tPlanIdx,
		const ipsdk::ipUInt64	pixelsStartOffset,
		const ipsdk::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

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/Python/PyIPSDKBase/PythonImageAccessor.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ init()

◆ hasBinary8BitsStorage()

◆ resizeData()

◆ readRawData()

◆ writeRawData()