ipsdk::image::DiskImage Class Reference

Image class with disk data storage support. More...

#include <DiskImage.h>

Inheritance diagram for ipsdk::image::DiskImage:

Public Member Functions
	~DiskImage ()
	destructor
eImageType	getImageType () const
	retrieve image type
ipBool	isGpuImage () const
	returns true if the image is loaded on GPU
ipBool	isDiskImage () const
	returns true if the image is a disk one
BoolResult	init (const DiskImageAccessorPtr &pDiskImageAccessor)
	image initialization More...
virtual BoolResult	init (const BaseImageGeometry &geometry)
	base image initialization, not used for disk image More...
BoolResult	fromSubImage (const PlanStorageColl3d &imagePlans)
	base image initialization from a collection of plan storage (typically obtained from a SubImge)
eImageAccessMode	getAccessMode () const
	retrieve image access mode More...
const BaseDiskImageAccessor &	getDiskImageAccessor () const
	retrieve image file accessor More...
const boost::filesystem::path &	getFilePath () const
	retrieve file path associated to image More...
BoolResult	resize (const BaseImageGeometry &geometry)
	resize of image given a new geometry More...
ipsdk::image::ImagePtr	loadPlan (const ipUInt64 z, const ipUInt64 c, const ipUInt64 t, const ipUInt64 sizeX=0, const ipUInt64 sizeY=0, const ipUInt64 offsetX=0, const ipUInt64 offsetY=0, const ipUInt64 strideX=1, const ipUInt64 strideY=1) const
	load a plan or a sub-plan to memory More...
ipsdk::image::ImagePtr	loadColorPlan (const ipUInt64 z, const ipUInt64 t, const ipUInt64 sizeX=0, const ipUInt64 sizeY=0, const ipUInt64 offsetX=0, const ipUInt64 offsetY=0, const ipUInt64 strideX=1, const ipUInt64 strideY=1) const
	load a color plan or a sub-plan to memory More...
ipReal64	readPixel (const ipUInt64 x, const ipUInt64 y, const ipUInt64 z=0, const ipUInt64 c=0, const ipUInt64 t=0)
	read a pixel from a given coordinate More...
BoolResult	writePixel (const ipReal64 value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 z=0, const ipUInt64 c=0, const ipUInt64 t=0)
	write a pixel a a given coordinate More...
Public Member Functions inherited from ipsdk::image::BaseCompleteImage
virtual	~BaseCompleteImage ()=0
	destructor
eImageBaseType	getImageBaseType () const
	retrieve image type
void	setName (const std::string &imageName)
	access to image name More...
BaseDataItem &	getHeaderItem (const std::string &key)
	retrieve a header item given associated key More...
void	addHeaderItem (const std::string &key, const DataItemPtr &pItem)
	add data item to header given associated key More...
void	removeHeaderItem (const std::string &key)
	remove item from header given associated key More...
void	clearHeader ()
	remove all items from header More...
Public Member Functions inherited from ipsdk::image::BaseImage
virtual	~BaseImage ()=0
	destructor
bool	isInit () const
	retrieve object initialisation flag
void	setScaleGeometricCalibration (const ipReal32 scale, const std::string &unitStr="")
	set geometric calibration associated to image by changing only the scale and the unit More...
void	setScaleGeometricCalibration (const ipReal32 xScale, const ipReal32 yScale, const std::string &unitStr="")
void	setScaleGeometricCalibration (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const std::string &unitStr="")
void	setOrigin (const ipReal32 xOrigin, const ipReal32 yOrigin)
	set geometric calibration associated to image More...
void	setOrigin (const ipReal32 xOrigin, const ipReal32 yOrigin, const ipReal32 zOrigin)
virtual bool	hasRemoteStorage () const
	method allowing to check whether image is associated to remote data (data with remote storage) More...
bool	hasBinary8BitsStorage () const
	method allowing to check whether image underlying storage stores binary data with a 8 bit alignment More...
bool	hasByPlanDataAccess () const
	check whether all plans have contiguous access to full plan data More...
PlanStorageConstPtr	getPlanStorage (const PlanIndex &planIndex) const
PlanStoragePtr	getPlanStorage (const PlanIndex &planIndex)
const PlanStorageColl3d &	getPlanStorageColl () const
std::string	getUserPropertiesStr () const
void	setUserPropertiesStr (const std::string &newStrUserProperties)
std::string	getChannelName (const ipUInt64 c) const
void	setChannelName (const std::string &strName, const ipUInt64 c)
bool	minIsBlack () const
	Returns true if the minimum image value is assigned to black. More...
void	clear ()
	clear of object data
const DataIdentifier &	getIdentifier () const
	retrieve identifier associated to image More...
const DataIdentifierConstPtr	getIdentifierPtr () const
	retrieve pointer to identifier associated to image More...
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...
DataItemConstPtr	getHeaderItemPtr (const std::string &key) const
	retrieve a header item given associated key More...
DataItemMapConstPtr	getHeaderPtr () const
	retrieve the header item map More...
bool	hasGeometricCalibration () const
	check whether image is associated to a geometric calibration More...
const GeometricCalibration &	getGeometricCalibration () const
	retrieve geometric calibration associated to image More...
const GeometricCalibrationConstPtr &	getGeometricCalibrationConstPtr () const
	retrieve geometric calibration associated to image More...
void	setGeometricCalibration (const GeometricCalibrationConstPtr &pGeometricCalibration)
	set geometric calibration associated to image More...
const BaseImageGeometry &	getGeometry () const
	retrieve image geometry More...
ImageGeometryConstPtr	getGeometryPtr () const
	retrieve image geometry More...
ipUInt64	getSizeX () const
	retrieve geometry plan x size More...
ipUInt64	getSizeY () const
	retrieve geometry plan y size More...
const VolumeGeometry &	getVolumeGeometry () const
	retrieve volume geometry (z) size and type More...
const eVolumeGeometryType &	getVolumeGeometryType () const
	retrieve volume geometry (z) type More...
ipUInt64	getSizeZ () const
	retrieve volume geometry (z) size More...
const ColorGeometry &	getColorGeometry () const
	retrieve color geometry (c) size and type More...
const eColorGeometryType &	getColorGeometryType () const
	retrieve color geometry (c) type More...
ipUInt64	getSizeC () const
	retrieve color geometry (c) size More...
const TemporalGeometry &	getTemporalGeometry () const
	retrieve temporal geometry (t) size and type More...
const eTemporalGeometryType &	getTemporalGeometryType () const
	retrieve temporal geometry (t) type More...
ipUInt64	getSizeT () const
	retrieve temporal geometry (t) size More...
ipUInt64	getNbTotPlans () const
	retrieve total number of plans for geometry More...
bool	isValidPlanIdx (const ipUInt64 zPlanIdx, const ipUInt64 cPlanIdx, const ipUInt64 tPlanIdx) const
	check whether a given plan index is valid More...
bool	isValidPlanIdx (const PlanIndex &planIdx) const
	check whether a given plan index is valid More...
const eImageBufferType &	getBufferType () const
	retrieve image data type More...
const eImageBufferType &	getBufferType (const ipUInt64 tPlanIdx) const
	retrieve image data type for a given temporal component More...
void	toGPU (CudaImagePtr pCudaImg) const
	Returns a copy of the image instance stored on NVidia device(s), specified by the input Cuda image.
CudaImagePtr	toGPU () const
	Returns a copy of the image instance stored on NVidia device(s)
ipBool	containSameData (const BaseImage &otherImage) const
void	setVolumeGeometryType (const eVolumeGeometryType &vType)
	Setters of geometry types : More...
void	setColorGeometryType (const eColorGeometryType &cType)
	Returns a copy of the image instance stored on NVidia device(s), specified by the input Cuda image.
void	setTemporalGeometryType (const eTemporalGeometryType &tType)
	Returns a copy of the image instance stored on NVidia device(s), specified by the input Cuda image.
void	setBufferType (const eImageBufferType &type)
	Returns a copy of the image instance stored on NVidia device(s), specified by the input Cuda image.
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

Static Public Attributes
static const eImageType::domain	g_imageType = eImageType::eIT_Disk
	type associated to attribute
Static Public Attributes inherited from ipsdk::image::BaseCompleteImage
static const eImageBaseType::domain	g_imageBaseType = eImageBaseType::eIBT_Complete
	type associated to attribute

Protected Member Functions
	DiskImage ()
	constructor
void	createImagePlans (const BaseImageGeometry &geometry, PlanStorageColl3d &imagePlans)
	method allowing to create image plan collection from a geometry
void	clearDerived ()
	clear data in derived class
template<typename T >
BoolResult	loadToMemory (const PlanStorageConstPtr pPlanStorage, const ipUInt64 offsetX, const ipUInt64 offsetY, const ipUInt64 strideX, const ipUInt64 strideY, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 imageSizeX, const ipUInt64 imageSizeY, T *pBuffer) const
	Load data from disk to memory.
template<typename T >
BoolResult	readPixelValue (ipReal64 &value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 sizeX, const PlanStoragePtr pPlanStorage)
	Read a pixel in the disk image.
template<typename T >
BoolResult	writePixelValue (const ipReal64 value, const ipUInt64 x, const ipUInt64 y, const ipUInt64 sizeX, const PlanStoragePtr pPlanStorage)
	Write a pixel in the disk image.
Protected Member Functions inherited from ipsdk::image::BaseCompleteImage
	BaseCompleteImage ()
	constructor
BoolResult	initBase (const ImageGeometryPtr &pGeometry, const PlanStorageColl3d &imagePlans)
	base class initialization method More...
DataIdentifierConstPtr	getIdentifier () const
	method allowing to access to image identifier
Protected Member Functions inherited from ipsdk::image::BaseImage
	BaseImage ()
	constructor
BoolResult	initBase (const DataIdentifierConstPtr &pIdentifier, const DataItemMapConstPtr &pHeader, const ImageGeometryPtr &pGeometry, const PlanStorageColl3d &imagePlans)
	base class initialization method More...
void	resizeBase (const ImageGeometryPtr &pGeometry, const PlanStorageColl3d &imagePlans)
	resize of image given a new geometry and a new image plan collection More...
bool	checkForRemoteStorage () const
	method allowing to check whether some plan storage are associated to remote storage More...
const PlanStorageColl3d &	accessImagePlans () const
	access to plan storage collection in derived class
PlanStorageColl3d &	accessImagePlans ()
	access to plan storage collection 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

Protected Attributes
DiskImageAccessorPtr	_pDiskImageAccessor
	pointer to image file accessor
Protected Attributes inherited from ipsdk::image::BaseCompleteImage
DataIdentifierPtr	_pIdentifier
	image identifier
DataItemMapPtr	_pHeader
	image header
Protected Attributes inherited from ipsdk::BaseObjectWithSkeleton
eSklSrzMode	_sklSrzMode
	serialization flag for object More...

Friends
boost::shared_ptr< DiskImage >	boost::make_shared ()

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

Image class with disk data storage support.

Author

E. Noirfalise

Date

2013/8/22

Copyright

2013 Reactiv'IP, all right reserved.

Member Function Documentation

init() [1/2]

BoolResult ipsdk::image::DiskImage::init

(

const DiskImageAccessorPtr &

pDiskImageAccessor

)

image initialization

Exceptions

ipsdk::image::IPSDKImageException	if pDiskImageAccessor.get() == 0
ipsdk::image::IPSDKImageException	if pDiskImageAccessor->isInit() == false

Returns

false in case of failure

init() [2/2]

virtual BoolResult ipsdk::image::DiskImage::init ( const BaseImageGeometry &  geometry )

virtual

base image initialization, not used for disk image

Returns

false

Implements ipsdk::image::BaseImage.

getAccessMode()

eImageAccessMode ipsdk::image::DiskImage::getAccessMode ( ) const

virtual

retrieve image access mode

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

Implements ipsdk::image::BaseImage.

getDiskImageAccessor()

const BaseDiskImageAccessor& ipsdk::image::DiskImage::getDiskImageAccessor

(

)

const

retrieve image file accessor

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

getFilePath()

const boost::filesystem::path& ipsdk::image::DiskImage::getFilePath

(

)

const

retrieve file path associated to image

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

resize()

BoolResult ipsdk::image::DiskImage::resize ( const BaseImageGeometry &  geometry )

virtual

resize of image given a new geometry

Exceptions

ipsdk::image::IPSDKImageException

if getAccessMode() != eImageAccessMode::eIAM_Resize

Returns

false in case of failure

Implements ipsdk::image::BaseCompleteImage.

loadPlan()

ipsdk::image::ImagePtr ipsdk::image::DiskImage::loadPlan	(	const ipUInt64	z,
		const ipUInt64	c,
		const ipUInt64	t,
		const ipUInt64	sizeX = 0,
		const ipUInt64	sizeY = 0,
		const ipUInt64	offsetX = 0,
		const ipUInt64	offsetY = 0,
		const ipUInt64	strideX = 1,
		const ipUInt64	strideY = 1
	)		const

load a plan or a sub-plan to memory

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

loadColorPlan()

ipsdk::image::ImagePtr ipsdk::image::DiskImage::loadColorPlan	(	const ipUInt64	z,
		const ipUInt64	t,
		const ipUInt64	sizeX = 0,
		const ipUInt64	sizeY = 0,
		const ipUInt64	offsetX = 0,
		const ipUInt64	offsetY = 0,
		const ipUInt64	strideX = 1,
		const ipUInt64	strideY = 1
	)		const

load a color plan or a sub-plan to memory

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

readPixel()

ipReal64 ipsdk::image::DiskImage::readPixel	(	const ipUInt64	x,
		const ipUInt64	y,
		const ipUInt64	z = 0,
		const ipUInt64	c = 0,
		const ipUInt64	t = 0
	)

read a pixel from a given coordinate

Exceptions

ipsdk::image::IPSDKImageException

if isInit() == false

writePixel()

BoolResult ipsdk::image::DiskImage::writePixel	(	const ipReal64	value,
		const ipUInt64	x,
		const ipUInt64	y,
		const ipUInt64	z = 0,
		const ipUInt64	c = 0,
		const ipUInt64	t = 0
	)

write a pixel a a given coordinate

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/Image/Disk/DiskImage.h