Base class for image strip fragments. More...

#include <BaseImageStrip.h>

Inheritance diagram for ipsdk::image::BaseImageStrip:

Public Member Functions
eImageFragmentType	getImageFragmentType () const
	retrieve image fragment type

virtual eImageStripType	getImageStripType () const =0
	retrieve image strip type

virtual const eImageBufferType &	getBufferType () const =0
	retrieve image buffer type More...

virtual const ipUInt64	getFullStripSize () const =0
	retrieve image strip size (number of pixels) More...

virtual const ipUInt64	getPlanStripSize () const =0
	retrieve xy plan image strip size (number of pixels) More...

virtual const ipUInt64	getStripNbPlans () const =0
	retrieve number of xy plans associated to strip More...

const eStripAllocationType &	getStripAllocationType () const
	retrieve flag indicating used strip allocation type More...

virtual ipBool	fromDisk () const
	returns true if the strip is extracted from a disk image

Constructors and destructors
	BaseImageStrip ()

virtual	~BaseImageStrip ()=0

Public Member Functions inherited from ipsdk::image::BaseImageFragment
virtual bool	isInput () const =0
	retrieve fragment input state More...

virtual bool	isOutput () const =0
	retrieve fragment output state More...

bool	isInOut () const
	retrieve fragment in/out state

bool	isInit () const
	retrieve object initialization flag

eDataAccessMode	getDataAccessMode () const
	retrieve flag indicating access mode for an image fragment data More...

bool	hasLocalDataAccess () const
	retrieve flag indicating whether fragment data can locally be accessed More...

bool	isBufferInit () const
	check whether strip buffer has been initialized More...

BoolResult	initBuffer ()
	method allowing to initialize strip buffer More...

void	clearBuffer ()
	method allowing to clear strip buffer More...

bool	isBufferSyncInput () const
	retrieve flag indicating whether buffer has been synchronised from image (read from image storage) More...

bool	isBufferSyncOutput () const
	retrieve flag indicating whether buffer has been synchronised to image (write to image storage) More...

void	clear ()
	clear object initialization data

	BaseImageFragment ()

virtual	~BaseImageFragment ()=0

const Guid &	getGuid () const
	access to image guid More...

const std::string &	getName () const
	access to image name More...

bool	existsHeaderKey (const std::string &key) const
	check whether a given key exists into header More...

ItemNames	getHeaderKeys () const
	retrieve header key list More...

const BaseDataItem &	getHeaderItem (const std::string &key) const
	retrieve a header item given associated key 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

Public Member Functions inherited from ipsdk::BaseIOData
virtual eIOStatus	getIOStatus () const =0
	retrieve data input/output status

	BaseIOData ()

virtual	~BaseIOData ()=0

Static Public Attributes
static const eImageFragmentType::domain	g_imageFragmentType = eImageFragmentType::eIFT_ImageStrip
	image strip type

Protected Member Functions
void	initBase (const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader, const eStripAllocationType &stripAllocationType)
	base class initialization method

Protected Member Functions inherited from ipsdk::image::BaseImageFragment
void	initBase (const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	base class initialization method

virtual eDataAccessMode	retrieveAccessMode () const =0
	method allowing to retrieve data access mode associated to fragment

virtual void	clearDerived ()=0
	clear function defined in derived class

virtual bool	isBufferInitDerived () const =0
	check whether strip buffer has been initialized in derived class

virtual BoolResult	initBufferDerived ()=0
	method allowing to initialize strip buffer in derived class

virtual void	clearBufferDerived ()=0
	method allowing to clear strip buffer in derived class

BoolResult	readData () const
	read image strip data from image storage More...

virtual BoolResult	readDataDerived () const =0
	read image strip data from image storage in derived class More...

BoolResult	writeData ()
	write image strip data to image storage More...

virtual BoolResult	writeDataDerived ()=0
	write image strip data to image storage in derived class 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
eStripAllocationType	_stripAllocationType
	flag indicating used strip allocation type

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

Base class for image strip fragments.

Author: E.Noirfalise

Date: 2015/01/09

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getBufferType()

virtual const eImageBufferType& ipsdk::image::BaseImageStrip::getBufferType ( ) const

pure virtual

retrieve image buffer type

Note: a returned value of eImageBufferType::eIBT_None stands for heterogeneous buffer type (sequence case)

Exceptions

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

Implemented in ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageXStrip2d, ipsdk::image::BaseImageYStrip3d, ipsdk::image::BaseImageYStripSeq2d, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, and ipsdk::image::BaseImageZStrip3dWithKernel.

◆ getFullStripSize()

virtual const ipUInt64 ipsdk::image::BaseImageStrip::getFullStripSize ( ) const

pure virtual

retrieve image strip size (number of pixels)

Exceptions

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

Implemented in ipsdk::image::BaseImageZStrip3dWithKernel, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageXStrip2d, ipsdk::image::BaseImageYStrip3d, and ipsdk::image::BaseImageYStripSeq2d.

◆ getPlanStripSize()

virtual const ipUInt64 ipsdk::image::BaseImageStrip::getPlanStripSize ( ) const

pure virtual

retrieve xy plan image strip size (number of pixels)

Exceptions

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

Implemented in ipsdk::image::BaseImageZStrip3dWithKernel, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageXStrip2d, ipsdk::image::BaseImageYStrip3d, and ipsdk::image::BaseImageYStripSeq2d.

◆ getStripNbPlans()

virtual const ipUInt64 ipsdk::image::BaseImageStrip::getStripNbPlans ( ) const

pure virtual

retrieve number of xy plans associated to strip

Exceptions

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

Implemented in ipsdk::image::BaseImageZStrip3dWithKernel, ipsdk::image::BaseImageXStrip2dWithKernel, ipsdk::image::BaseImageYStrip2dWithKernel, ipsdk::image::BaseImageZStripColor3d, ipsdk::image::BaseImageYStrip2d, ipsdk::image::BaseImageYStripColor2d, ipsdk::image::BaseImageZStrip3d, ipsdk::image::BaseImageXStrip2d, ipsdk::image::BaseImageYStrip3d, and ipsdk::image::BaseImageYStripSeq2d.

◆ getStripAllocationType()

const eStripAllocationType& ipsdk::image::BaseImageStrip::getStripAllocationType ( ) const

retrieve flag indicating used strip allocation type

Exceptions

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

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

/media/reactivipdev/Nightly/IPSDK_Patch/IPSDK_4_1/IPSDK_Nightly/include/public/IPSDKImage/Fragment/Strip/BaseImageStrip.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBufferType()

◆ getFullStripSize()

◆ getPlanStripSize()

◆ getStripNbPlans()

◆ getStripAllocationType()