Input and output class for 2d image tiles. More...

#include <InOutImageTile2d.h>

Inheritance diagram for ipsdk::image::InOutImageTile2d:

Public Types
typedef BaseImage	ImageType

typedef PlanStoragePtr	InputStorageType

Public Member Functions
FragHybridBuffer &	getBuffer ()
	retrieve tile full buffer More...

template<typename T >
T *	getBuffer (const ipUInt64 rowIdx)
	retrieve tile row buffer for a given row index More...

Constructors and destructor
	InOutImageTile2d ()

	~InOutImageTile2d ()

Tile read and write access
BoolResult	readFromImage () const
	read image tile data from image storage More...

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

Public Member Functions inherited from ipsdk::image::BaseImageTile2d
eImageTileType	getImageTileType () const
	retrieve image tile type

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

const ipUInt64	getFullTileSize () const
	retrieve image tile size (number of pixels) More...

const ipUInt64	getPlanTileSize () const
	retrieve xy plan image tile size (number of pixels) More...

const ipUInt64	getTileNbPlans () const
	retrieve number of xy plans associated to tile More...

const FragHybridBuffer &	getBuffer () const
	retrieve tile full buffer More...

template<typename T >
const T *	getBuffer (const ipUInt64 rowIdx) const
	retrieve tile row buffer for a given row index More...

	BaseImageTile2d ()

virtual	~BaseImageTile2d ()=0

ipUInt64	getImageSizeX () const
	retrieve full image size More...

ipUInt64	getImageSizeY () const
	retrieve full image size More...

ipInt64	getTileStartOffsetX () const
	retrieve tile start offsets in full image More...

ipInt64	getTileStartOffsetY () const
	retrieve tile start offsets in full image More...

ipUInt64	getTileSizeX () const
	retrieve tile size More...

ipUInt64	getTileSizeY () const
	retrieve tile size More...

ipUInt64	getTileEndOffsetX () const
	retrieve tile end offsets in full image (first coordinates after tile) More...

ipUInt64	getTileEndOffsetY () const
	retrieve tile end offsets in full image (first coordinates after tile) More...

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

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

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

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

	BaseImageTile ()

virtual	~BaseImageTile ()=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

Protected Member Functions
void	init (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 tileStartOffsetX, const ipUInt64 tileStartOffsetY, const ipUInt64 tileSizeX, const ipUInt64 tileSizeY, const PlanStoragePtr &pPlanStorage, const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	initialization of object with a plan storage support More...

void	init (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipUInt64 tileStartOffsetX, const ipUInt64 tileStartOffsetY, const ipUInt64 tileSizeX, const ipUInt64 tileSizeY, const ipUInt64 imageSizeX, const ipUInt64 imageSizeY, const eImageBufferType &bufferType, const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	initialization of object without plan storage support More...

Protected Member Functions inherited from ipsdk::image::BaseImageTile2d
void	initBase (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipInt64 tileStartOffsetX, const ipInt64 tileStartOffsetY, const ipUInt64 tileSizeX, const ipUInt64 tileSizeY, const PlanStoragePtr &pPlanStorage, const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	base class initialization with a plan storage support

void	initBase (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx, const ipInt64 tileStartOffsetX, const ipInt64 tileStartOffsetY, const ipUInt64 tileSizeX, const ipUInt64 tileSizeY, const ipUInt64 imageSizeX, const ipUInt64 imageSizeY, const eImageBufferType &bufferType, const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader)
	base class initialization without plan storage support

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

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

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

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

FragHybridBuffer &	accessBuffer () const
	access to tile full buffer More...

void	clearDerived ()
	clear function defined in derived class

void	retrieveIntersection (tile::ImageTileInfo2d &imageTileInfo2d) const
	method allowing to retrieve tile/image intersection More...

BoolResult	readDataDerived () const
	read image tile data from image storage More...

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

const void *	accessBuffer (const ipUInt64 rowIdx) const
	access to tile tile row buffer for a given row index More...

void *	accessBuffer (const ipUInt64 rowIdx)
	access to tile tile row buffer for a given row index More...

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

Friends
struct	ImageTileExtractor

class	InOutImageTile3d

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

Static Public Attributes inherited from ipsdk::image::BaseImageTile2d
static const eImageTileType::domain	g_imageTileType = eImageTileType::eITT_2d
	image tile type

Static Public Attributes inherited from ipsdk::image::BaseImageTile
static const eImageFragmentType::domain	g_imageFragmentType = eImageFragmentType::eIFT_ImageTile
	image fragment type

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

Detailed Description

Input and output class for 2d image tiles.

Author: E.Noirfalise

Date: 2016/09/06

Copyright: 2016 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getBuffer() [1/2]

FragHybridBuffer & ipsdk::image::InOutImageTile2d::getBuffer ( )

inline

retrieve tile full buffer

Exceptions

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

◆ getBuffer() [2/2]

template<typename T >

T* ipsdk::image::InOutImageTile2d::getBuffer ( const ipUInt64 rowIdx )

inline

retrieve tile row buffer for a given row index

Exceptions

ipsdk::image::IPSDKImageException	if isBufferInit() == false
ipsdk::image::IPSDKImageException	if rowIdx >= getTileSizeY()

◆ readFromImage()

BoolResult ipsdk::image::InOutImageTile2d::readFromImage ( ) const

read image tile data from image storage

Exceptions

ipsdk::image::IPSDKImageException	if isBufferInit() == false
ipsdk::image::IPSDKImageException	if hasLocalDataAccess() == false

Returns: false in case of failure

◆ writeToImage()

BoolResult ipsdk::image::InOutImageTile2d::writeToImage ( )

write image strip data to image storage

Exceptions

ipsdk::image::IPSDKImageException	if isBufferInit() == false
ipsdk::image::IPSDKImageException	if hasLocalDataAccess() == false
ipsdk::image::IPSDKImageException	if getAccessMode() == eImageAccessMode::eIAM_Read

Returns: false in case of failure

◆ init() [1/2]

void ipsdk::image::InOutImageTile2d::init	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx,
		const ipUInt64	tileStartOffsetX,
		const ipUInt64	tileStartOffsetY,
		const ipUInt64	tileSizeX,
		const ipUInt64	tileSizeY,
		const PlanStoragePtr &	pPlanStorage,
		const DataIdentifierConstPtr &	pImageIdentifier,
		const DataItemMapConstPtr &	pImageHeader
	)

protected

initialization of object with a plan storage support

Exceptions

ipsdk::image::IPSDKImageException	if tileStartOffsetX + tileSizeX > pPlanStorage->getSizeX()
ipsdk::image::IPSDKImageException	if tileStartOffsetY + tileSizeY > pPlanStorage->getSizeY()

◆ init() [2/2]

void ipsdk::image::InOutImageTile2d::init	(	const ipUInt64	zPlanIdx,
		const ipUInt64	cPlanIdx,
		const ipUInt64	tPlanIdx,
		const ipUInt64	tileStartOffsetX,
		const ipUInt64	tileStartOffsetY,
		const ipUInt64	tileSizeX,
		const ipUInt64	tileSizeY,
		const ipUInt64	imageSizeX,
		const ipUInt64	imageSizeY,
		const eImageBufferType &	bufferType,
		const DataIdentifierConstPtr &	pImageIdentifier,
		const DataItemMapConstPtr &	pImageHeader
	)

protected

initialization of object without plan storage support

Exceptions

ipsdk::image::IPSDKImageException	if tileStartOffsetX + tileSizeX/2 > imageSizeX
ipsdk::image::IPSDKImageException	if tileStartOffsetY + tileSizeY/2 > imageSizeY

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/Tile/Tile2d/InOutImageTile2d.h

Public Types

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getBuffer() [1/2]

◆ getBuffer() [2/2]

◆ readFromImage()

◆ writeToImage()

◆ init() [1/2]

◆ init() [2/2]