Class for sub images of complete image. More...

#include <SubImage.h>

Inheritance diagram for ipsdk::image::SubImage:

Public Member Functions
	~SubImage ()
	destructor

eImageBaseType	getImageBaseType () 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

eImageAccessMode	getAccessMode () const
	retrieve image access mode More...

bool	hasRemoteStorage () const
	method allowing to check whether image is associated to remote data (data with remote storage) More...

virtual BoolResult	init (const BaseImageGeometry &geometry)
	base image initialization, not used for sub image 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)

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 eImageBaseType::domain	g_imageBaseType = eImageBaseType::eIBT_Sub
	type associated to attribute

Protected Member Functions
	SubImage ()
	constructor

BoolResult	init (const DataIdentifierConstPtr &pImageIdentifier, const DataItemMapConstPtr &pImageHeader, const eImageAccessMode &imageAccessMode, const ImageGeometryPtr &pSubImageGeometry, const GeometricCalibrationConstPtr &pGeometricCalibration, const ipBool bIsGpuImage, const ipBool bIsDiskImage, PlanStorageColl3d &imagePlans)
	class initialization method More...

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

virtual void	clearDerived ()
	clear data in derived class

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
eImageAccessMode	_imageAccessMode
	image access mode

ipBool	_bIsGpuImage
	Is the image loaded on GPU.

ipBool	_bIsDiskImage
	Is the image a disk image.

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

Friends
struct	SubImageExtractor

boost::shared_ptr< SubImage >	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

Class for sub images of complete image.

Author: E. Noirfalise

Date: 2013/10/8

Copyright: 2013 Reactiv'IP, all right reserved.

Member Function Documentation

◆ getAccessMode()

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

virtual

retrieve image access mode

Exceptions

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

Implements ipsdk::image::BaseImage.

◆ hasRemoteStorage()

bool ipsdk::image::SubImage::hasRemoteStorage ( ) const

virtual

method allowing to check whether image is associated to remote data (data with remote storage)

Exceptions

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

Returns: true if image is associated to remote data

Reimplemented from ipsdk::image::BaseImage.

◆ init() [1/2]

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

virtual

base image initialization, not used for sub image

Returns: false

Implements ipsdk::image::BaseImage.

◆ init() [2/2]

BoolResult ipsdk::image::SubImage::init	(	const DataIdentifierConstPtr &	pImageIdentifier,
		const DataItemMapConstPtr &	pImageHeader,
		const eImageAccessMode &	imageAccessMode,
		const ImageGeometryPtr &	pSubImageGeometry,
		const GeometricCalibrationConstPtr &	pGeometricCalibration,
		const ipBool	bIsGpuImage,
		const ipBool	bIsDiskImage,
		PlanStorageColl3d &	imagePlans
	)

protected

class initialization method

Returns: false in case of failure

Warning: there is no check on sub image geometry validity regards to provided image plans since this method is protected and only available from BaseImage class

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getAccessMode()

◆ hasRemoteStorage()

◆ init() [1/2]

◆ init() [2/2]