Base class for image 2d strip with splitting along Y axis associated to a kernel. More...

#include <BaseImageYStrip2dWithKernel.h>

Inheritance diagram for ipsdk::image::BaseImageYStrip2dWithKernel:

Public Member Functions
eImageStripType	getImageStripType () const
	retrieve image strip type

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

Constructors and destructors
	BaseImageYStrip2dWithKernel ()

virtual	~BaseImageYStrip2dWithKernel ()=0

Kernel informations
ipUInt64	getKernelSizeX () const
	retrieve full kernel X size associated to object More...

ipUInt64	getKernelSizeY () const
	retrieve full kernel Y size associated to object More...

ipUInt64	getStartingKernelSizeX () const
	retrieve starting kernel X size associated to object More...

ipUInt64	getEndingKernelSizeX () const
	retrieve ending kernel X size associated to object More...

ipUInt64	getStartingKernelSizeY () const
	retrieve starting kernel Y size associated to object More...

ipUInt64	getEndingKernelSizeY () const
	retrieve ending kernel Y size associated to object More...

Main strip structure informations
const eStripParsingDirection &	getStripParsingDirection () const
	access to used strip parsing direction More...

ipUInt64	getSizeX () const
	retrieve image size along x direction More...

ipUInt64	getStripStartOffsetY () const
	retrieve strip start offset for data along y direction More...

ipUInt64	getStripSizeY () const
	retrieve strip data size along y direction More...

ipUInt64	getImageSizeY () const
	retrieve full image size along y direction More...

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

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

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

Starting and ending informations
ipUInt64	getStartingSizeY () const
	retrieve number of provided starting rows (number of additional provided rows for kernel Y size processing) More...

ipUInt64	getNbMissingStartingRows () const
	retrieve number of missing starting rows (number of missing rows for kernel Y size processing) More...

ipUInt64	getEndingSizeY () const
	retrieve number of provided ending rows (number of additional provided rows for kernel Y size processing) More...

ipUInt64	getNbMissingEndingRows () const
	retrieve number of missing ending rows (number of missing rows for kernel Y size processing) More...

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

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

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

Image strips access
ImageYStrip2dConstPtr	getStartingStripPtr () const
	retrieve starting image strip More...

ImageYStrip2dConstPtr	getMainStripPtr () const
	retrieve main image strip More...

ImageYStrip2dConstPtr	getEndingStripPtr () const
	retrieve ending image strip More...

Public Member Functions inherited from ipsdk::image::BaseImageStrip
eImageFragmentType	getImageFragmentType () const
	retrieve image fragment type

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

	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 eImageStripType::domain	g_imageStripType = eImageStripType::eIST_Y2dWithKernel
	image strip type

Static Public Attributes inherited from ipsdk::image::BaseImageStrip
static const eImageFragmentType::domain	g_imageFragmentType = eImageFragmentType::eIFT_ImageStrip
	image strip type

Protected Member Functions
void	initBase (const ipUInt64 startingKernelSizeX, const ipUInt64 endingKernelSizeX, const ipUInt64 startingKernelSizeY, const ipUInt64 endingKernelSizeY, const ImageYStrip2dPtr &pStartingStrip, const ImageYStrip2dPtr &pMainStrip, const ImageYStrip2dPtr &pEndingStrip, const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	base class initialization More...

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

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

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

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

void	clearDerived ()
	clear function defined in derived class

Strip read and write access
BoolResult	readDataDerived () const
	read image strip data from image storage More...

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

Protected Member Functions inherited from ipsdk::image::BaseImageStrip
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

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

BoolResult	writeData ()
	write image strip data to image storage 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

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::BaseImageStrip
eStripAllocationType	_stripAllocationType
	flag indicating used strip allocation type

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

Detailed Description

Base class for image 2d strip with splitting along Y axis associated to a kernel.

Author: E.Noirfalise

Date: 2015/01/09

Copyright: 2015 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getBufferType()

const eImageBufferType& ipsdk::image::BaseImageYStrip2dWithKernel::getBufferType ( ) const

virtual

retrieve image buffer type

Exceptions

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

Implements ipsdk::image::BaseImageStrip.

◆ getKernelSizeX()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getKernelSizeX ( ) const

retrieve full kernel X size associated to object

Exceptions

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

Returns: getStartingKernelSizeX() + getEndingKernelSizeX() + 1

◆ getKernelSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getKernelSizeY ( ) const

retrieve full kernel Y size associated to object

Exceptions

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

Returns: getStartingKernelSizeY() + getEndingKernelSizeY() + 1

◆ getStartingKernelSizeX()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStartingKernelSizeX ( ) const

retrieve starting kernel X size associated to object

Exceptions

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

◆ getEndingKernelSizeX()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getEndingKernelSizeX ( ) const

retrieve ending kernel X size associated to object

Exceptions

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

◆ getStartingKernelSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStartingKernelSizeY ( ) const

retrieve starting kernel Y size associated to object

Exceptions

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

◆ getEndingKernelSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getEndingKernelSizeY ( ) const

retrieve ending kernel Y size associated to object

Exceptions

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

◆ getStripParsingDirection()

const eStripParsingDirection& ipsdk::image::BaseImageYStrip2dWithKernel::getStripParsingDirection ( ) const

access to used strip parsing direction

Exceptions

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

◆ getSizeX()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getSizeX ( ) const

retrieve image size along x direction

Exceptions

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

◆ getStripStartOffsetY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStripStartOffsetY ( ) const

retrieve strip start offset for data along y direction

Exceptions

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

◆ getStripSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStripSizeY ( ) const

retrieve strip data size along y direction

Exceptions

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

◆ getImageSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getImageSizeY ( ) const

retrieve full image size along y direction

Exceptions

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

◆ getFullStripSize()

const ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getFullStripSize ( ) const

virtual

retrieve image strip size (number of pixels)

Exceptions

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

Warning: kernel additional data (rows) are not taken into account

Implements ipsdk::image::BaseImageStrip.

◆ getPlanStripSize()

const ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getPlanStripSize ( ) const

virtual

retrieve xy plan image strip size (number of pixels)

Exceptions

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

Implements ipsdk::image::BaseImageStrip.

◆ getStripNbPlans()

const ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStripNbPlans ( ) const

virtual

retrieve number of xy plans associated to strip

Exceptions

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

Implements ipsdk::image::BaseImageStrip.

◆ getStartingSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getStartingSizeY ( ) const

retrieve number of provided starting rows (number of additional provided rows for kernel Y size processing)

Exceptions

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

◆ getNbMissingStartingRows()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getNbMissingStartingRows ( ) const

retrieve number of missing starting rows (number of missing rows for kernel Y size processing)

Exceptions

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

◆ getEndingSizeY()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getEndingSizeY ( ) const

retrieve number of provided ending rows (number of additional provided rows for kernel Y size processing)

Exceptions

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

◆ getNbMissingEndingRows()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getNbMissingEndingRows ( ) const

retrieve number of missing ending rows (number of missing rows for kernel Y size processing)

Exceptions

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

◆ getZPlanIdx()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getZPlanIdx ( ) const

retrieve z plan index for image strip in full image

Exceptions

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

◆ getCPlanIdx()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getCPlanIdx ( ) const

retrieve c plan index for image strip in full image

Exceptions

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

◆ getTPlanIdx()

ipUInt64 ipsdk::image::BaseImageYStrip2dWithKernel::getTPlanIdx ( ) const

retrieve t plan index for image strip in full image

Exceptions

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

◆ getStartingStripPtr()

ImageYStrip2dConstPtr ipsdk::image::BaseImageYStrip2dWithKernel::getStartingStripPtr ( ) const

retrieve starting image strip

Exceptions

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

◆ getMainStripPtr()

ImageYStrip2dConstPtr ipsdk::image::BaseImageYStrip2dWithKernel::getMainStripPtr ( ) const

retrieve main image strip

Exceptions

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

◆ getEndingStripPtr()

ImageYStrip2dConstPtr ipsdk::image::BaseImageYStrip2dWithKernel::getEndingStripPtr ( ) const

retrieve ending image strip

Exceptions

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

◆ initBase()

void ipsdk::image::BaseImageYStrip2dWithKernel::initBase	(	const ipUInt64	startingKernelSizeX,
		const ipUInt64	endingKernelSizeX,
		const ipUInt64	startingKernelSizeY,
		const ipUInt64	endingKernelSizeY,
		const ImageYStrip2dPtr &	pStartingStrip,
		const ImageYStrip2dPtr &	pMainStrip,
		const ImageYStrip2dPtr &	pEndingStrip,
		const DataIdentifierConstPtr &	pImageIdentifier,
		const DataItemMapConstPtr &	pImageHeader
	)

protected

base class initialization

Note: pStartingStrip may be null, in this case no starting data are provided (case of first rows of data in 2d image); pEndingStrip may be null, in this case no ending data are provided (case of last rows of data in 2d image)

Exceptions

ipsdk::image::IPSDKImageException	if pMainStrip.get() == 0
ipsdk::image::IPSDKImageException	if pMainStrip.isInit() == false

◆ readDataDerived()

BoolResult ipsdk::image::BaseImageYStrip2dWithKernel::readDataDerived ( ) const

protectedvirtual

read image strip data from image storage

Returns: false in case of failure

Implements ipsdk::image::BaseImageFragment.

◆ writeDataDerived()

BoolResult ipsdk::image::BaseImageYStrip2dWithKernel::writeDataDerived ( )

protectedvirtual

write image strip data to image storage

Returns: false in case of failure

Implements ipsdk::image::BaseImageFragment.

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/YStrip2dWithKernel/BaseImageYStrip2dWithKernel.h

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBufferType()

◆ getKernelSizeX()

◆ getKernelSizeY()

◆ getStartingKernelSizeX()

◆ getEndingKernelSizeX()

◆ getStartingKernelSizeY()

◆ getEndingKernelSizeY()

◆ getStripParsingDirection()

◆ getSizeX()

◆ getStripStartOffsetY()

◆ getStripSizeY()

◆ getImageSizeY()

◆ getFullStripSize()

◆ getPlanStripSize()

◆ getStripNbPlans()

◆ getStartingSizeY()

◆ getNbMissingStartingRows()

◆ getEndingSizeY()

◆ getNbMissingEndingRows()

◆ getZPlanIdx()

◆ getCPlanIdx()

◆ getTPlanIdx()

◆ getStartingStripPtr()

◆ getMainStripPtr()

◆ getEndingStripPtr()

◆ initBase()

◆ readDataDerived()

◆ writeDataDerived()