Base class for image files accessors. More...

#include <BaseDiskImageAccessor.h>

Inheritance diagram for ipsdk::image::BaseDiskImageAccessor:

Public Member Functions
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...

Constructors and destructors
	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...

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

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

virtual BoolResult	readRawData (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 pixelsStartOffset, const ipUInt64 nbPixels, void *pData) const =0
	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)=0
	write row data segment to user image 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 image files accessors.

Author: E. Noirfalise

Date: 2013/8/29

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getFilePath()

const boost::filesystem::path& ipsdk::image::BaseDiskImageAccessor::getFilePath ( ) const

retrieve file path associated to object

Exceptions

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

◆ hasSharedRemoteAccess()

bool ipsdk::image::BaseDiskImageAccessor::hasSharedRemoteAccess ( ) const

retrieve flag indicating whether image has remote shared access (image can be accessed from every where on network)

Exceptions

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

◆ getImageInfoStr()

std::string ipsdk::image::BaseDiskImageAccessor::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::BaseDiskImageAccessor::initBase	(	const boost::filesystem::path &	filePath,
		const eImageAccessMode &	accessMode,
		const BaseImageGeometry &	geometry,
		const GeometricCalibrationConstPtr &	pGeometricCalibration,
		const bool	bSharedRemoteAccess
	)

protected

base class initialization method

Parameters

filePath	path to image file
accessMode	read/write/resize access mode for file
geometry	underlying geometry for image file

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/BaseDiskImageAccessor.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getFilePath()

◆ hasSharedRemoteAccess()

◆ getImageInfoStr()

◆ initBase()