Namespace agregating IPSDK image management routines and classes. More...

Namespaces
	file
	Namespace agregating IPSDK image file (disk image) management routines and classes.

	tools
	Namespace aggregating basic image tools components.

Classes
class	AutoDiskImageAccessor

class	BaseCompleteImage
	Base class for complete images. More...

class	BaseDiskImageAccessor
	Base class for image files accessors. More...

class	BaseImage
	Base class for images data type. More...

class	BaseImageAccessor
	Base class for image accessors. More...

class	BaseImageFragment
	Base class for image fragments. More...

class	BaseImageGeometry
	Base class for image geometry. More...

class	BaseImageStrip
	Base class for image strip fragments. More...

class	BaseImageTile
	Base class for image tile. More...

class	BaseImageTile2d
	Base class for 2 image tiles. More...

class	BaseImageTile3d
	Base class for 3d image tiles. More...

class	BaseImageXStrip2d
	Base class for image 2d strip with splitting along X axis. More...

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

class	BaseImageYStrip2d
	Base class for image 2d strip with splitting along Y axis. More...

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

class	BaseImageYStrip3d
	Base class for image 3d strip with splitting along Y axis. More...

class	BaseImageYStripColor2d
	Base class for color image 2d strip with splitting along Y axis. More...

class	BaseImageYStripSeq2d
	Base class for sequence image 2d strip with splitting along Y axis. More...

class	BaseImageZStrip3d
	Base class for image 3d strip with splitting along Z axis. More...

class	BaseImageZStrip3dWithKernel
	Base class for image 3d strip with splitting along Z axis associated to a kernel. More...

class	BaseImageZStripColor3d
	Base class for color image 3d strip with splitting along Z axis. More...

class	BasePlanStorage
	Base class for image plan data storage. More...

class	BaseUserImageAccessor
	Base class for user image accessors. More...

class	Border2dPolicy
	Class used to define policy for 2d strip borders management during a kernel algorithm processing. More...

class	Border3dPolicy
	Class used to define policy for 3d strip borders management during a kernel algorithm processing. More...

class	ColorGeometry
	Class encapsulating color geometryThis class allows to define geometry color size and type (grey, rgb, ...) More...

struct	ColorGeometryType2Size

class	CudaImage

class	CudaPlanStorage

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

class	DiskPlanStorage
	Class encapsulating disk plan data. More...

class	DistributedImage
	Image class with distributed data storage policy. More...

class	DistributedPlanStorage
	Class encapsulating distributed plan storage. More...

class	GpuImage
	Image class with data stored into GPU. More...

class	GpuPlanStorage
	Class encapsulating GPU plan data. More...

class	HeterogeneousImageGeometry
	Image geometry associated to heterogeneous image buffer types through image plans (sequence case) More...

class	HomogeneousImageGeometry
	Image geometry associated to constant image buffer types through image plans. More...

struct	ImageCoords
	structure allowing to agregate informations about image coordinates More...

class	ImageFactory
	Singleton object used to manage new images creation. More...

class	ImagePlanGeometry
	Class encapsulating image plan geometry. More...

class	ImageRowSegmentInfo
	Class used to store image row segment informations. More...

class	ImageSegmentData
	Class encapsulating image segment data. More...

class	ImageSegmentInfo
	Class used to store image segment informations. More...

struct	ImageStripExtractor
	Structure used to extract image strips from an image. More...

struct	ImageTileExtractor
	Structure used to extract image tiles from an image. More...

struct	ImageTileInfo2d
	structure allowing to agregate informations about coordinates of intersection between a tile and an image in 2d More...

struct	ImageTileInfo3d
	structure allowing to agregate informations about coordinates of intersection between a tile and an image in 3d More...

struct	ImageType2Buffer

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

class	InOutImageTile3d
	Input and output class for 3d image tiles. More...

class	InOutImageXStrip2d
	Input and output class for image 2d strip with splitting along X axis. More...

class	InOutImageYStrip2d
	Input and output class for image 2d strip with splitting along Y axis. More...

class	InOutImageYStrip3d
	Input and output class for image 3d strip with splitting along Y axis. More...

class	InOutImageYStripColor2d
	Input and output class for color image 2d strip with splitting along Y axis. More...

class	InOutImageYStripSeq2d
	Input and output class for sequence image 2d strip with splitting along Y axis. More...

class	InOutImageZStrip3d
	Input and output class for image 3d strip with splitting along Z axis. More...

class	InOutImageZStripColor3d
	Input and output class for color image 3d strip with splitting along Z axis. More...

class	InputImageTile2d
	Input class for 2d image tiles. More...

class	InputImageTile3d
	Input class for 3d image tiles. More...

class	InputImageXStrip2d
	Input class for image 2d strip with splitting along X axis. More...

class	InputImageXStrip2dWithKernel
	Input class for image 2d strip with splitting along X axis associated to a kernel. More...

class	InputImageYStrip2d
	Input class for image 2d strip with splitting along Y axis. More...

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

class	InputImageYStrip3d
	Input class for image 3d strip with splitting along Y axis. More...

class	InputImageYStripColor2d
	Input class for color image 2d strip with splitting along Y axis. More...

class	InputImageYStripSeq2d
	Input class for sequence image 2d strip with splitting along Y axis. More...

class	InputImageZStrip3d
	Input class for image 3d strip with splitting along Z axis. More...

class	InputImageZStrip3dWithKernel
	Input class for image 3d strip with splitting along Z axis associated to a kernel. More...

class	InputImageZStripColor3d
	Input class for color image 3d strip with splitting along Z axis. More...

class	IPSDKImageException
	Exception class for library IPSDKImage. More...

class	MemoryImage
	Image class with data stored into memory. More...

class	MemoryPlanStorage
	Class encapsulating memory plan data. More...

class	MultiFileDiskImageAccessor

class	OutputImageTile2d
	Output class for 2d image tiles. More...

class	OutputImageTile3d
	Output class for 3d image tiles. More...

class	OutputImageXStrip2d
	Output class for image 2d strip with splitting along X axis. More...

class	OutputImageYStrip2d
	Output class for image 2d strip with splitting along Y axis. More...

class	OutputImageYStrip3d
	Output class for image 3d strip with splitting along Y axis. More...

class	OutputImageYStripColor2d
	Output class for color image 2d strip with splitting along Y axis. More...

class	OutputImageYStripSeq2d
	Output class for sequence image 2d strip with splitting along Y axis. More...

class	OutputImageZStrip3d
	Output class for image 3d strip with splitting along Z axis. More...

class	OutputImageZStripColor3d
	Output class for color image 3d strip with splitting along Z axis. More...

class	PlanExtractor
	Class allowing to extract a plan from several image types (memory, disk, ...) More...

class	ReInterpretedPlanStorage
	Class allowing to encapsulate a virtual reinterpreted plan storage associated to a real plan storage. More...

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

struct	SubImageExtractor

class	TemporalGeometry
	Class encapsulating temporal geometryThis class allows to define geometry temporal size and type (single or sequence) More...

struct	TileCoords
	structure allowing to agregate informations about tile coordinates More...

class	UserImage
	Image class with user data storage support. More...

class	UserPlanStorage
	Class encapsulating user plan data. More...

class	VolumeGeometry
	Class encapsulating volume geometryThis class allows to define geometry volume size and type (2d or 3d) More...

Typedefs
typedef boost::shared_ptr< BaseImageGeometry >	ImageGeometryPtr
	shared pointer to image geometry

typedef boost::shared_ptr< const BaseImageGeometry >	ImageGeometryConstPtr
	shared pointer to const image geometry

typedef std::vector< eImageBufferType >	ImageBufferTypeVector
	collection of buffer types

typedef boost::shared_ptr< BaseDiskImageAccessor >	DiskImageAccessorPtr
	shared pointer to disk image accessor

typedef std::map< ElementsRange, Guid >	LocationMap
	collection associating a strip range with a socket Guid

typedef boost::function< BoolResult(const BaseImageGeometry &, ImagePtr &)>	ImageCreationFunction
	function allowing to create a new image from a geometry

typedef boost::shared_ptr< BaseUserImageAccessor >	UserImageAccessorPtr
	shared pointer to user images accessor

typedef std::vector< ImageSegmentInfo >	SegInfoColl
	collection of image segment informations

typedef std::vector< ImageRowSegmentInfo >	RowSegInfoColl
	collection of image row segment informations

typedef boost::shared_ptr< BasePlanStorage >	PlanStoragePtr
	shared pointer to image plan storage

typedef boost::shared_ptr< const BasePlanStorage >	PlanStorageConstPtr
	shared pointer to const image plan storage


typedef boost::shared_ptr< Border2dPolicy >	Border2dPolicyPtr
	shared pointer to Border2dPolicy

typedef boost::shared_ptr< const Border2dPolicy >	Border2dPolicyConstPtr
	shared pointer to Border2dPolicy


typedef boost::shared_ptr< Border3dPolicy >	Border3dPolicyPtr
	shared pointer to Border3dPolicy

typedef boost::shared_ptr< const Border3dPolicy >	Border3dPolicyConstPtr
	shared pointer to Border3dPolicy


typedef boost::shared_ptr< BaseImageStrip >	ImageStripPtr

typedef boost::shared_ptr< const BaseImageStrip >	ImageStripConstPtr


typedef boost::shared_ptr< BaseImageXStrip2d >	ImageXStrip2dPtr

typedef boost::shared_ptr< const BaseImageXStrip2d >	ImageXStrip2dConstPtr


typedef boost::shared_ptr< BaseImageYStrip2d >	ImageYStrip2dPtr

typedef boost::shared_ptr< const BaseImageYStrip2d >	ImageYStrip2dConstPtr


typedef boost::shared_ptr< BaseImageYStrip2dWithKernel >	ImageYStrip2dWithKernelPtr

typedef boost::shared_ptr< const BaseImageYStrip2dWithKernel >	ImageYStrip2dWithKernelConstPtr


typedef boost::shared_ptr< BaseImageYStrip3d >	ImageYStrip3dPtr

typedef boost::shared_ptr< const BaseImageYStrip3d >	ImageYStrip3dConstPtr


typedef boost::shared_ptr< BaseImageYStripColor2d >	ImageYStripColor2dPtr

typedef boost::shared_ptr< const BaseImageYStripColor2d >	ImageYStripColor2dConstPtr


typedef boost::shared_ptr< BaseImageYStripSeq2d >	ImageYStripSeq2dPtr

typedef boost::shared_ptr< const BaseImageYStripSeq2d >	ImageYStripSeq2dConstPtr


typedef boost::shared_ptr< BaseImageZStrip3d >	ImageZStrip3dPtr

typedef boost::shared_ptr< const BaseImageZStrip3d >	ImageZStrip3dConstPtr


typedef boost::shared_ptr< BaseImageZStrip3dWithKernel >	ImageZStrip3dWithKernelPtr

typedef boost::shared_ptr< const BaseImageZStrip3dWithKernel >	ImageZStrip3dWithKernelConstPtr


typedef boost::shared_ptr< BaseImageTile >	ImageTilePtr

typedef boost::shared_ptr< const BaseImageTile >	ImageTileConstPtr


typedef boost::shared_ptr< BaseImageTile2d >	ImageTile2dPtr

typedef boost::shared_ptr< const BaseImageTile2d >	ImageTile2dConstPtr


typedef boost::shared_ptr< InputImageTile2d >	InputImageTile2dPtr

typedef boost::shared_ptr< const InputImageTile2d >	InputImageTile2dConstPtr


typedef boost::shared_ptr< InOutImageTile2d >	InOutImageTile2dPtr

typedef boost::shared_ptr< const InOutImageTile2d >	InOutImageTile2dConstPtr


typedef boost::shared_ptr< OutputImageTile2d >	OutputImageTile2dPtr

typedef boost::shared_ptr< const OutputImageTile2d >	OutputImageTile2dConstPtr


typedef boost::shared_ptr< BaseImageTile3d >	ImageTile3dPtr

typedef boost::shared_ptr< const BaseImageTile3d >	ImageTile3dConstPtr


typedef boost::shared_ptr< InputImageTile3d >	InputImageTile3dPtr

typedef boost::shared_ptr< const InputImageTile3d >	InputImageTile3dConstPtr


typedef boost::shared_ptr< InOutImageTile3d >	InOutImageTile3dPtr

typedef boost::shared_ptr< const InOutImageTile3d >	InOutImageTile3dConstPtr


typedef boost::shared_ptr< OutputImageTile3d >	OutputImageTile3dPtr

typedef boost::shared_ptr< const OutputImageTile3d >	OutputImageTile3dConstPtr


typedef boost::shared_ptr< DistributedImage >	DistributedImagePtr

typedef boost::shared_ptr< const DistributedImage >	DistributedImageConstPtr


typedef boost::weak_ptr< DistributedImage >	DistributedImageWeakPtr

typedef boost::weak_ptr< const DistributedImage >	DistributedImageConstWeakPtr


typedef boost::shared_ptr< BaseImage >	ImagePtr

typedef boost::shared_ptr< const BaseImage >	ImageConstPtr


typedef boost::weak_ptr< BaseImage >	ImageWeakPtr

typedef boost::weak_ptr< const BaseImage >	ImageConstWeakPtr


typedef boost::shared_ptr< DiskImage >	DiskImagePtr

typedef boost::shared_ptr< const DiskImage >	DiskImageConstPtr


typedef boost::shared_ptr< MemoryImage >	MemoryImagePtr

typedef boost::shared_ptr< const MemoryImage >	MemoryImageConstPtr


typedef boost::shared_ptr< UserImage >	UserImagePtr

typedef boost::shared_ptr< const UserImage >	UserImageConstPtr


typedef boost::shared_ptr< CudaImage >	CudaImagePtr

typedef boost::shared_ptr< const CudaImage >	CudaImageConstPtr


typedef std::vector< PlanStoragePtr >	PlanStorageColl1d

typedef std::vector< PlanStorageConstPtr >	PlanStorageConstColl1d


typedef std::vector< PlanStorageColl1d >	PlanStorageColl2d

typedef std::vector< PlanStorageConstColl1d >	PlanStorageConstColl2d


typedef std::vector< PlanStorageColl2d >	PlanStorageColl3d

typedef std::vector< PlanStorageConstColl2d >	PlanStorageConstColl3d

Enumerations
enum	eImageAccessorMessage { eImageAccessorNoPlanAccess, eImageAccessorNotInit, eImageAccessorWriteNotAllowed, eImageAccessorResizeNotAllowed, eImageAccessorResizeFailed, eInvalidZCTPlanIndex, eWrongIm6MagicNumber, eCreateFileFailed, eCreateFileFailedWin32, eReserveSpaceFailed, eReserveSpaceFailedWin32, eInvalidPlanIdx, eSeekFailed, eReadFailed, eWriteFailed, eWriteFailedWin32, eOpenFileFailed, eGeometryGreaterThanFileSize, eErrorDiskImgePathDoesNotExist, eErrorCantRemoveDiskImgeFile }
	Enumerate describing messages. More...

enum	eBorder2dMessage { eNotInit, eCantGetValuedType, eCantGetFillValue, eCantGetTheta }
	Enumerate describing messages. More...

enum	eBorder2dType { eB2DT_Valued, eB2DT_Continue, eB2DT_Miror, eB2DT_LinearContinue, eB2DT_LinearMiror }
	Enumerate describing image data preparator 2d border type. More...

enum	eValuedBorder2dType { eVB2DT_Custom, eVB2DT_Min, eVB2DT_Max }
	Enumerate describing valued border 2d used value type. More...

enum	eBorder3dMessage { eNotInit, eCantGetValuedType, eCantGetFillValue }
	Enumerate describing messages. More...

enum	eBorder3dType { eB3DT_Valued, eB3DT_Continue, eB3DT_Miror }
	Enumerate describing image data preparator 3d border type. More...

enum	eValuedBorder3dType { eVB3DT_Custom, eVB3DT_Min, eVB3DT_Max }
	Enumerate describing valued border 3d used value type. More...

enum	eImageFragmentExtractorMessage { eCantExtract3dStrip, eCantExtract3dSubImage, eCantExtractColorStrip, eCantExtractColorSubImage, eCantExtractSequenceSubImage, eCantExtractTemporalStrip, eCantReInterpretImageData, eColorGeometryTypeMismatch, eDataTypeMismatch, eFailedToCreateReInterpretedSubImage, eFailedToCreateTemporalStrip, eInvalidCPlanIndex, eInvalidCTPlanIndex, eInvalidDeviceIndex, eInvalidEndingKernelSizeX, eInvalidEndingKernelSizeY, eInvalidEndingKernelSizeZ, eInvalidImageCCoord, eInvalidImageTCoord, eInvalidImageXCoord, eInvalidImageYCoord, eInvalidImageZCoord, eInvalidNextXStrip2dSizeX, eInvalidNextXStrip2dSizeY, eInvalidNextYStrip2dSizeX, eInvalidNextYStrip2dSizeY, eInvalidNextZStrip3dSizeX, eInvalidNextZStrip3dSizeY, eInvalidNextZStrip3dSizeZ, eInvalidPreviousXStrip2dSizeX, eInvalidPreviousXStrip2dSizeY, eInvalidPreviousYStrip2dSizeX, eInvalidPreviousYStrip2dSizeY, eInvalidPreviousZStrip3dSizeX, eInvalidPreviousZStrip3dSizeY, eInvalidPreviousZStrip3dSizeZ, eInvalidStartingKernelSizeX, eInvalidStartingKernelSizeY, eInvalidStartingKernelSizeZ, eInvalidTPlanIndex, eInvalidTemporalCoords, eInvalidTemporalSize, eInvalidXStrip2dEndingOffsetX, eInvalidXStrip2dStartingOffsetX, eInvalidXStripCoords, eInvalidYStrip2dEndingOffsetY, eInvalidYStrip2dStartingOffsetY, eInvalidYStripCoords, eInvalidZCPlanIndex, eInvalidZCTPlanIndex, eInvalidZPlanIndex, eInvalidZRange, eInvalidZStrip3dEndingOffsetZ, eInvalidZStrip3dStartingOffsetZ, eInvalidZStripCoords, eInvalidZTPlanIndex, eNbImagesInCollShouldBeGreaterThanOne, eNullFragmentSize, eSizeCMismatch, eSizeXMismatch, eSizeYMismatch, eSizeTMismatch, eSizeZMismatch, eVolumeGeometryTypeMismatch }
	Enumerate describing messages. More...

enum	eImageFragmentMessage { eImageFragmentBufferNotInit, eImageFragmentNoDataAccess, eImageFragmentNotInit, eImageWriteNotGranted, eInvalidImageCPlanIndex, eInvalidImageZPlanIndex, eMemoryAllocationFailed, eNullInputSharedPtr, eFailedToCreateColorVolumeStrip }
	Enumerate describing messages. More...

enum	eImageFragmentType { eIFT_ImageStrip, eIFT_ImageTile }
	Enumerate describing image fragment type. More...

enum	eDataAccessMode { eDAM_LocalMemory, eDAM_LocalDisk, eDAM_SharedDisk, eDAM_LocalFragment, eDAM_RemoteFragment, eDAM_NoAccess }
	Enumerate describing access mode for an image fragment data. More...

enum	eImageStripMessage { eEmptyTemporalColl, eEmptyVolumeColl, eInvalidColorCollSize, eInvalidStripCCoord, eInvalidStripTCoord, eInvalidStripXCoord, eInvalidStripYCoord, eInvalidStripZCoord, eInvalidStripZRange, eInvalidVolumeCollSize, eMixedStripDistributedPlanStorage, eNonHomogeneousAccessMode, eNullStripPtr }
	Enumerate describing messages. More...

enum	eImageStripType { eIST_X2d, eIST_Y2d, eIST_X2dWithKernel, eIST_Y2dWithKernel, eIST_Y3d, eIST_YColor2d, eIST_YSeq2d, eIST_Z3d, eIST_Z3dWithKernel, eIST_ZColor3d }
	Enumerate describing image strip type. More...

enum	eStripParsingDirection { eSPD_Direct, eSPD_Reverse }
	Enumerate describing strip parsing direction. More...

enum	eStripAllocationType { eSAT_NoAllocation, eSAT_InSitu }
	Enumerate describing image strip allocation policy. More...

enum	eImageTileMessage { eInvalidTileEndOffsetX, eInvalidTileEndOffsetY, eInvalidTileEndOffsetZ, eInvalidTileRangeX, eInvalidTileRangeY, eInvalidTileRangeZ, eInvalidTileYCoord, eInvalidTileZCoord, eNonHomogeneousAccessMode, eUnsupportedBorderPolicy, eUnsupportedImageBufferType }
	Enumerate describing messages. More...

enum	eImageTileType { eITT_2d, eITT_3d }
	Enumerate describing image tile type. More...

enum	eGeometryComponentMessage { eColorGeometryNotInit, eNotColorSpaceConversionKnown, eNullColorSize, eNullSequenceSize, eNullVolumeSize, eTemporalGeometryNotInit, eUnSupportedEnumValue, eUnknownColorSize, eVolumeGeometryNotInit, eBadColorChannelIndex, eBadVolumeGeometryType, eBadColorGeometryType, eBadTemporalGeometryType }
	Enumerate describing messages. More...

enum	eVolumeGeometryType { eVGT_2d, eVGT_3d }
	Volume geometry type. More...

enum	eColorGeometryType { eCGT_Grey, eCGT_Rgb, eCGT_Rgba, eCGT_XYZ, eCGT_YPbPr, eCGT_YCbCr, eCGT_CieLab, eCGT_CieLuv, eCGT_HLS, eCGT_HSV, eCGT_User }
	Color geometry type. More...

enum	eTemporalGeometryType { eTGT_Single, eTGT_Sequence }
	Temporal geometry type. More...

enum	eRgbColorComponent { eCC_Red, eCC_Green, eCC_Blue }
	Color components associated to RGB color geometry. More...

enum	eRgbaColorComponent { eCC_Red, eCC_Green, eCC_Blue, eCC_Alpha }
	Color components associated to RGBA color geometry. More...

enum	eXYZColorComponent { eCC_X, eCC_Y, eCC_Z }
	Color components associated to XYZ color geometry. More...

enum	eYPbPrColorComponent { eCC_Y, eCC_Pb, eCC_Pr }
	Color components associated to YPbPr color geometry. More...

enum	eYCbCrColorComponent { eCC_Y, eCC_Cb, eCC_Cr }
	Color components associated to YCbCr color geometry. More...

enum	eLabColorComponent { eCC_L, eCC_A, eCC_B }
	Color components associated to CIE Lab color geometry. More...

enum	eLuvColorComponent { eCC_L, eCC_U, eCC_V }
	Color components associated to CIE Luv color geometry. More...

enum	eHLSColorComponent { eCC_H, eCC_L, eCC_S }
	Color components associated to HLS color geometry. More...

enum	eHSVColorComponent { eCC_H, eCC_S, eCC_V }
	Color components associated to HSV color geometry. More...

enum	eGeometryMessage { eImageGeometryNotInit, eInvalidGeometryTPlanIndex, eInvalidImageBufferType, eTSizeAndBufferTypeCollSizeMismatch }
	Enumerate describing messages. More...

enum	eImageGeometryType { eIGT_Homogeneous, eIGT_Heterogeneous }
	Image geometry type. More...

enum	ePlanGeometryMessage { ePlanGeometryNotInit, eInvalidImageBufferType }
	Enumerate describing messages. More...

enum	eImageMessage { eBaseNotShared, eBinaryWithout8BitsSupportNotReInterpretable, eDiskImageNullAccessor, eDistributedImageInitFailed, eDistributedImageResizeFailed, eEmptyImageBufferType, eErrorDeviceIndex, eFailedCreateImage, eFailedToCreatePlan, eFailedToResizePlan, eFailedToResizeGpuPlan, eHeterogeneousNotReInterpretable, eImageNameFormatFull, eImageNameFormatGuid, eImageNameFormatName, eImageNotInit, eInvalidImageBufferType, eInvalidImageNameFormat, eInvalidPlanIndex, eMemoryImageInitFailed, eGpuImageInitFailed, eMemoryImageResizeFailed, eGpuImageResizeFailed, eMismatchingBaseMemorySizeNotReInterpretable, eNbPlansNotReInterpretable, eNotGeometricCalibration, ePixelsByPlansNotReInterpretable, eResizeImageNotGranted, eUnNamedImageName, eUserImageNullAccessor, eErrorInputImageNotInitilized, eErrorBadSizeY, eErrorbadIndexC, eErrorbadIndexT, eErrorCantCopyImgToGpuWithoutGpuSupport, eNullCpuBuffer, eCantLoadPlanFromMemory, eBadBufferType, eCantReadPixelValue }
	Enumerate describing messages. More...

enum	eImageBaseType { eIBT_Complete, eIBT_Sub }
	Enumerate describing image base type. More...

enum	eImageType { eIT_Memory, eIT_Disk, eIT_User, eIT_Gpu, eIT_Distributed, eIT_Custom }
	Enumerate describing image type. More...

enum	eImageBufferType { eIBT_None, eIBT_Int8, eIBT_UInt8, eIBT_Int16, eIBT_UInt16, eIBT_Int32, eIBT_UInt32, eIBT_Real32, eIBT_Binary, eIBT_Label16, eIBT_Label32, eIBT_Label8 }
	types associated to image buffers More...

enum	eImageAccessMode { eIAM_Read, eIAM_Write, eIAM_Resize }
	Image access mode. More...

enum	eFormatedType { eFT_Full, eFT_Name, eFT_Guid }
	Type for generation of formated image name. More...

enum	eIPSDKImageMessage { eErrorCreateCpuFromGpu, eErrorCantCopyBufferFromGpuToCpu, eErrorCantCopyBufferFromGpuToCpuGeomMismatch, eDifferentBufferBaseSize, eWarnObsolete }
	Enumerate describing messages. More...

enum	ePlanStorageMessage { eBinaryWithout8BitsSupportNotReInterpretable, eCantReInterpretStorage, eCantResizeDiskPlan, eCantResizeDistributedPlan, eCantResizeReInterpretedPlan, eCantResizeUserPlan, eInvalidDataOffset, eInvalidDataOffsetX, eInvalidDataOffsetY, eInvalidLocationMapData, eInvalidYCoords, eLocationMapAndGeometryMismatch, eMemoryAllocationFailed, eMismatchingBaseMemorySizeNotReInterpretable, eNbPixelsNotReInterpretable, eNullImageIdentifier, ePlanStorageNotInit, eResizeFailed }
	Enumerate describing messages. More...

enum	ePlanStorageType { ePST_Memory, ePST_Disk, ePST_User, ePST_Distributed, ePST_ReInterpreted, ePST_Gpu, ePST_Custom }
	Enumerate describing plan storage type. More...

Functions
IPSDKIMAGE_API Border2dPolicyPtr	valuedBorder2d (const ipReal64 fillValue)
	function allowing to generate a 2d border manager used to extend border values to a constant given value

IPSDKIMAGE_API Border2dPolicyPtr	valuedMaxBorder2d ()
	function allowing to generate a 2d border manager used to extend border values using a maximum value for a given image type

IPSDKIMAGE_API Border2dPolicyPtr	valuedMinBorder2d ()
	function allowing to generate a 2d border manager used to extend border values using a minimum value for a given image type

IPSDKIMAGE_API Border2dPolicyPtr	continueBorder2d ()
	function allowing to generate a 2d border manager used to extend border values by direct continuity

IPSDKIMAGE_API Border2dPolicyPtr	mirorBorder2d ()
	function allowing to generate a 2d border manager used to extend border values mirroring existing data

IPSDKIMAGE_API Border2dPolicyPtr	linearContinueBorder2d (const ipReal64 theta)
	function allowing to generate a 2d border manager used to extend border values linearly continuing existing data using a given direction. See Rotations 2d for more informations about angle conventions

IPSDKIMAGE_API Border2dPolicyPtr	linearMirorBorder2d (const ipReal64 theta)
	function allowing to generate a border manager used to extend border values linearly mirroring existing data using a given direction. See Rotations 2d for more informations about angle conventions

IPSDKIMAGE_API Border3dPolicyPtr	valuedBorder3d (const ipReal64 fillValue)
	function allowing to generate a 3d border manager used to extend border values to a constant given value

IPSDKIMAGE_API Border3dPolicyPtr	valuedMaxBorder3d ()
	function allowing to generate a 3d border manager used to extend border values using a maximum value for a given image type

IPSDKIMAGE_API Border3dPolicyPtr	valuedMinBorder3d ()
	function allowing to generate a 3d border manager used to extend border values using a minimum value for a given image type

IPSDKIMAGE_API Border3dPolicyPtr	continueBorder3d ()
	function allowing to generate a 3d border manager used to extend border values by direct continuity

IPSDKIMAGE_API Border3dPolicyPtr	mirorBorder3d ()
	function allowing to generate a 3d border manager used to extend border values mirroring existing data

IPSDKIMAGE_API ImagePtr	reInterpretImageData (const ImagePtr &pOriginalImage, const BaseImageGeometry &targetGeometry)
	function allowing to create a reinterpreted version of an image More...

IPSDKIMAGE_API std::string	getFormatedName (const BaseImageFragment &fragment, const eFormatedType &formatedType=eFormatedType::eFT_Full)
	format image name associated to fragment for display More...

IPSDKIMAGE_API eDataAccessMode	retrieveDataAccessMode (const PlanStorageConstPtr &pPlanStorage)

IPSDKIMAGE_API eDataAccessMode	retrieveDataAccessMode (const PlanStorageConstPtr &pPlanStorage, const ipUInt64 startOffsetY, const ipUInt64 sizeY)

IPSDKIMAGE_API bool	areCompatible (const eDataAccessMode &dataAccessMode0, const eDataAccessMode &dataAccessMode1)
	check whether two access mode are compatible amond a storage collection

IPSDKIMAGE_API void	processBorders (const eImageBufferType &imageBufferType, const Border2dPolicy &border2dPolicy, const tile::ImageTileInfo2d &imageTileInfo2d, FragHybridBuffer &buffer)
	method allowing to complete a tile buffer with border data given a border policy

IPSDKIMAGE_API ipUInt32	getColorGeometrySize (const eColorGeometryType &colorGeometryType)
	retrieve size (number of plans) of a color geometry More...

IPSDKIMAGE_API bool	hasLinearTransform (const eColorGeometryType &sourceColorSpace, const eColorGeometryType &targetColorSpace)
	check whether a linear transformation is available between two color spaces

IPSDKIMAGE_API ipsdk::math::Matrix	getLinearTransform (const eColorGeometryType &sourceColorSpace, const eColorGeometryType &targetColorSpace, const eImageBufferType &sourceImageBufferType=eImageBufferType::eIBT_None, const eImageBufferType &targetImageBufferType=eImageBufferType::eIBT_None)
	retrieve linear transformation associated to a given color space conversion operation More...

IPSDKIMAGE_API VolumeGeometry	geometry2d ()
	create a 2d volume geometry

IPSDKIMAGE_API VolumeGeometry	geometry3d (const ipUInt64 sizeZ)
	create a 3d volume geometry

IPSDKIMAGE_API ColorGeometry	geometryGrey ()
	create a grey level color geometry

IPSDKIMAGE_API ColorGeometry	geometryRgb ()
	create a rgb color geometry

IPSDKIMAGE_API ColorGeometry	geometryUser (const ipUInt64 sizeC)
	create a user color geometry

IPSDKIMAGE_API ColorGeometry	geometryColor (const eColorGeometryType &colorGeometryType)
	create a color geometry associated to a given color space More...

IPSDKIMAGE_API TemporalGeometry	geometrySingle ()
	create a single element temporal geometry

IPSDKIMAGE_API TemporalGeometry	geometrySequence (const ipUInt64 sizeT)
	create a sequence temporal geometry

IPSDKIMAGE_API bool	isEqual (const VolumeGeometry &volumeGeometry1, const VolumeGeometry &volumeGeometry2)
	compare two volume geometry More...

IPSDKIMAGE_API bool	isEqual (const ColorGeometry &colorGeometry1, const ColorGeometry &colorGeometry2)
	compare two color geometry More...

IPSDKIMAGE_API bool	isEqual (const TemporalGeometry &temporalGeometry1, const TemporalGeometry &temporalGeometry2)
	compare two temporal geometry More...

IPSDKIMAGE_API ImageGeometryPtr	geometry (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const VolumeGeometry &volumeGeometry, const ColorGeometry &colorGeometry, const TemporalGeometry &temporalGeometry)
	create an image geometry

IPSDKIMAGE_API ImageGeometryPtr	geometry2d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY)
	create a 2d image geometry

IPSDKIMAGE_API ImageGeometryPtr	geometry3d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 sizeZ)
	create a 3d image geometry

IPSDKIMAGE_API ImageGeometryPtr	geometryRgb2d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY)
	create a rgb 2d image geometry

IPSDKIMAGE_API ImageGeometryPtr	geometryRgb3d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 sizeZ)
	create a rgb 3d image geometry

IPSDKIMAGE_API ImageGeometryPtr	geometry2d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const eColorGeometryType &colorGeometryType)
	create a color 2d image geometry More...

IPSDKIMAGE_API ImageGeometryPtr	geometry3d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 sizeZ, const eColorGeometryType &colorGeometryType)
	create a color 3d image geometry More...

IPSDKIMAGE_API ImageGeometryPtr	geometrySeq2d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 sizeT)
	create a sequence of 2d images geometry

IPSDKIMAGE_API ImageGeometryPtr	geometrySeq3d (const eImageBufferType &imageBufferType, const ipUInt64 sizeX, const ipUInt64 sizeY, const ipUInt64 sizeZ, const ipUInt64 sizeT)
	create a sequence of 3d images geometry

IPSDKIMAGE_API bool	haveSameSize (const BaseImageGeometry &geometry1, const BaseImageGeometry &geometry2)
	compare two image geometry size More...

IPSDKIMAGE_API bool	isEqual (const BaseImageGeometry &geometry1, const BaseImageGeometry &geometry2)
	compare two image geometry More...

IPSDKIMAGE_API ImageGeometryPtr	createBoundingGeometry (const BaseImageGeometry &geometry1, const BaseImageGeometry &geometry2, const eImageBufferType &outputBufferType)
	function allowing to create a bounding geometry for two input images geometries and a target output buffer More...

IPSDKIMAGE_API bool	isEqual (const ImagePlanGeometry &planGeometry1, const ImagePlanGeometry &planGeometry2)
	compare two image plan geometry More...

IPSDKIMAGE_API eDataType	toDataType (const eImageBufferType &imageBufferType)
	recovery of underlying data type from image buffer type

IPSDKIMAGE_API ipUInt32	getImageBufferBaseSize (const eImageBufferType &imageBufferType)
	recovery of image buffer size from its type (in octets)

IPSDKIMAGE_API std::string	getFormatedName (const DataIdentifier &imageIdentifier, const eFormatedType &formatedType=eFormatedType::eFT_Full)
	format image name for display

IPSDKIMAGE_API std::string	getFormatedName (const BaseImage &image, const eFormatedType &formatedType=eFormatedType::eFT_Full)
	format image name for display More...

IPSDKIMAGE_API ipReal64	getMinValue (const eImageBufferType &imageBufferType)
	retrieve minimum value for a given image buffer type More...

IPSDKIMAGE_API ipReal64	getMaxValue (const eImageBufferType &imageBufferType)
	retrieve maximum value for a given image buffer type More...

IPSDKIMAGE_API BoolResult	canBeReInterpreted (const BaseImage &originalImage, const BaseImageGeometry &targetGeometry)
	fonction allowing to check whether data of an image can be re interpreted with a different geometry. This allows for example reuse of working images for different usages. More...

IPSDKIMAGE_API BoolResult	createImage (const BaseImage &originalImage, ImagePtr &pOutImg)
	function allowing to create an image from an existing other image More...

IPSDKIMAGE_API ImagePtr	createImage (const BaseImage &originalImage)
	function allowing to create an image from an existing other image More...

IPSDKIMAGE_API BoolResult	createImage (const BaseImage &originalImage, const eImageBufferType &outImageBufferType, ImagePtr &pOutImg)
	function allowing to create an image from an existing other image More...

IPSDKIMAGE_API ImagePtr	createImage (const BaseImage &originalImage, const eImageBufferType &outImageBufferType)
	function allowing to create an image from an existing other image More...

template<typename T >
IPSDKIMAGE_API const T *	extractBufferFromConstImage (const BaseImage &inImg, const ipUInt64 sizeY, const ipUInt64 z=0, const ipUInt64 c=0, const ipUInt64 t=0)
	function allowing to retrieve the buffer of a constant image plan More...

template<typename T >
IPSDKIMAGE_API T *	extractBufferFromImage (BaseImage &inImg, const ipUInt64 sizeY, const ipUInt64 z=0, const ipUInt64 c=0, const ipUInt64 t=0)
	function allowing to retrieve the buffer of an image plan More...

IPSDKIMAGE_API const std::string &	getIPSDKImageLoggerName ()
	Recovery of logger name associated to library.

IPSDKIMAGE_API log4cplus::Logger &	getIPSDKImageLogger ()
	Recovery of logger associated to library.

IPSDKIMAGE_API const LogMessageManager &	getIPSDKImageLogMessageManager ()
	Recovery of message manager associated to library.

IPSDKIMAGE_API BoolResult	canBeReInterpreted (const BasePlanStorage &originalPlanStorage, const ImagePlanGeometry &targetPlanGeometry)
	fonction allowing to check whether a plan storage can be re interpreted with a different geometry. This allows for example reuse of working images for different usages. More...


IPSDKIMAGE_API void	computeIntersection (const ipUInt64 imageSizeX, const ipUInt64 tileStartOffsetX, const ipUInt64 tileSizeX, const ipUInt64 imageSizeY, const ipUInt64 tileStartOffsetY, const ipUInt64 tileSizeY, tile::ImageTileInfo2d &imageTileInfo2d)
	method allowing to compute image/tile intersection informations

IPSDKIMAGE_API void	computeIntersection (const ipUInt64 imageSizeX, const ipUInt64 tileStartOffsetX, const ipUInt64 tileSizeX, const ipUInt64 imageSizeY, const ipUInt64 tileStartOffsetY, const ipUInt64 tileSizeY, const ipUInt64 imageSizeZ, const ipUInt64 tileStartOffsetZ, const ipUInt64 tileSizeZ, tile::ImageTileInfo3d &imageTileInfo3d)
	method allowing to compute image/tile intersection informations


	COLORGEOMETRYTYPE_TO_SIZE (eCGT_Grey, 1)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_Rgb, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_Rgba, 4)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_XYZ, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_YPbPr, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_YCbCr, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_CieLab, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_CieLuv, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_HLS, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_HSV, 3)

	COLORGEOMETRYTYPE_TO_SIZE (eCGT_User, 0)


IPSDKIMAGE_API ImagePtr	reinterpretVolumeSequence (BaseImage &img)
	reinterpret an image geometry Volume <-> Sequence

IPSDKIMAGE_API ImagePtr	reinterpretVolumeSequence (ImagePtr &pImg)
	reinterpret an image geometry Volume <-> Sequence

IPSDKIMAGE_API ImagePtr	reinterpretVolumeToSequence (BaseImage &img)
	reinterpret an image geometry Volume <-> Sequence

IPSDKIMAGE_API ImagePtr	reinterpretVolumeToSequence (ImagePtr &pImg)
	reinterpret an image geometry Volume <-> Sequence

IPSDKIMAGE_API ImagePtr	reinterpretSequenceToVolume (BaseImage &img)
	reinterpret an image geometry Volume <-> Sequence

IPSDKIMAGE_API ImagePtr	reinterpretSequenceToVolume (ImagePtr &pImg)
	reinterpret an image geometry Volume <-> Sequence


IPSDKIMAGE_API ImagePtr	reinterpretVolumeMultiChannel (BaseImage &img)
	reinterpret an image geometry Volume <-> MultiChannel

IPSDKIMAGE_API ImagePtr	reinterpretVolumeMultiChannel (ImagePtr &pImg)
	reinterpret an image geometry Volume <-> MultiChannel


IPSDKIMAGE_API ImagePtr	reinterpretSequenceMultiChannel (BaseImage &img)
	reinterpret an image geometry Sequence <-> MultiChannel

IPSDKIMAGE_API ImagePtr	reinterpretSequenceMultiChannel (ImagePtr &pImg)
	reinterpret an image geometry Sequence <-> MultiChannel


	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Int8, ipInt8)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_UInt8, ipUInt8)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Int16, ipInt16)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_UInt16, ipUInt16)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Int32, ipInt32)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_UInt32, ipUInt32)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Real32, ipReal32)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Binary, ipUInt8)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Label16, ipUInt16)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Label32, ipUInt32)

	IMAGETYPE_TO_BUFFER_STRUCT (eIBT_Label8, ipUInt8)

Detailed Description

Namespace agregating IPSDK image management routines and classes.

Typedef Documentation

◆ ImageStripPtr

typedef boost::shared_ptr<BaseImageStrip> ipsdk::image::ImageStripPtr

shared pointer to BaseImageStrip

◆ ImageStripConstPtr

typedef boost::shared_ptr<const BaseImageStrip> ipsdk::image::ImageStripConstPtr

shared pointer to BaseImageStrip

◆ ImageXStrip2dPtr

typedef boost::shared_ptr<BaseImageXStrip2d> ipsdk::image::ImageXStrip2dPtr

shared pointer to BaseImageXStrip2d

◆ ImageXStrip2dConstPtr

typedef boost::shared_ptr<const BaseImageXStrip2d> ipsdk::image::ImageXStrip2dConstPtr

shared pointer to BaseImageXStrip2d

◆ ImageYStrip2dPtr

typedef boost::shared_ptr<BaseImageYStrip2d> ipsdk::image::ImageYStrip2dPtr

shared pointer to BaseImageYStrip2d

◆ ImageYStrip2dConstPtr

typedef boost::shared_ptr<const BaseImageYStrip2d> ipsdk::image::ImageYStrip2dConstPtr

shared pointer to BaseImageYStrip2d

◆ ImageYStrip2dWithKernelPtr

typedef boost::shared_ptr<BaseImageYStrip2dWithKernel> ipsdk::image::ImageYStrip2dWithKernelPtr

shared pointer to BaseImageYStrip2dWithKernel

◆ ImageYStrip2dWithKernelConstPtr

typedef boost::shared_ptr<const BaseImageYStrip2dWithKernel> ipsdk::image::ImageYStrip2dWithKernelConstPtr

shared pointer to BaseImageYStrip2dWithKernel

◆ ImageYStrip3dPtr

typedef boost::shared_ptr<BaseImageYStrip3d> ipsdk::image::ImageYStrip3dPtr

shared pointer to BaseImageYStrip3d

◆ ImageYStrip3dConstPtr

typedef boost::shared_ptr<const BaseImageYStrip3d> ipsdk::image::ImageYStrip3dConstPtr

shared pointer to BaseImageYStrip3d

◆ ImageYStripColor2dPtr

typedef boost::shared_ptr<BaseImageYStripColor2d> ipsdk::image::ImageYStripColor2dPtr

shared pointer to BaseImageYStripColor2d

◆ ImageYStripColor2dConstPtr

typedef boost::shared_ptr<const BaseImageYStripColor2d> ipsdk::image::ImageYStripColor2dConstPtr

shared pointer to BaseImageYStripColor2d

◆ ImageYStripSeq2dPtr

typedef boost::shared_ptr<BaseImageYStripSeq2d> ipsdk::image::ImageYStripSeq2dPtr

shared pointer to BaseImageYStripSeq2d

◆ ImageYStripSeq2dConstPtr

typedef boost::shared_ptr<const BaseImageYStripSeq2d> ipsdk::image::ImageYStripSeq2dConstPtr

shared pointer to BaseImageYStripSeq2d

◆ ImageZStrip3dPtr

typedef boost::shared_ptr<BaseImageZStrip3d> ipsdk::image::ImageZStrip3dPtr

shared pointer to BaseImageZStrip3d

◆ ImageZStrip3dConstPtr

typedef boost::shared_ptr<const BaseImageZStrip3d> ipsdk::image::ImageZStrip3dConstPtr

shared pointer to BaseImageZStrip3d

◆ ImageZStrip3dWithKernelPtr

typedef boost::shared_ptr<BaseImageZStrip3dWithKernel> ipsdk::image::ImageZStrip3dWithKernelPtr

shared pointer to BaseImageZStrip3dWithKernel

◆ ImageZStrip3dWithKernelConstPtr

typedef boost::shared_ptr<const BaseImageZStrip3dWithKernel> ipsdk::image::ImageZStrip3dWithKernelConstPtr

shared pointer to BaseImageZStrip3dWithKernel

◆ ImageTilePtr

typedef boost::shared_ptr<BaseImageTile> ipsdk::image::ImageTilePtr

shared pointer to BaseImageTile

◆ ImageTileConstPtr

typedef boost::shared_ptr<const BaseImageTile> ipsdk::image::ImageTileConstPtr

shared pointer to BaseImageTile

◆ ImageTile2dPtr

typedef boost::shared_ptr<BaseImageTile2d> ipsdk::image::ImageTile2dPtr

shared pointer to BaseImageTile2d

◆ ImageTile2dConstPtr

typedef boost::shared_ptr<const BaseImageTile2d> ipsdk::image::ImageTile2dConstPtr

shared pointer to BaseImageTile2d

◆ InputImageTile2dPtr

typedef boost::shared_ptr<InputImageTile2d> ipsdk::image::InputImageTile2dPtr

shared pointer to InputImageTile2d

◆ InputImageTile2dConstPtr

typedef boost::shared_ptr<const InputImageTile2d> ipsdk::image::InputImageTile2dConstPtr

shared pointer to InputImageTile2d

◆ InOutImageTile2dPtr

typedef boost::shared_ptr<InOutImageTile2d> ipsdk::image::InOutImageTile2dPtr

shared pointer to InOutImageTile2d

◆ InOutImageTile2dConstPtr

typedef boost::shared_ptr<const InOutImageTile2d> ipsdk::image::InOutImageTile2dConstPtr

shared pointer to InOutImageTile2d

◆ OutputImageTile2dPtr

typedef boost::shared_ptr<OutputImageTile2d> ipsdk::image::OutputImageTile2dPtr

shared pointer to OutputImageTile2d

◆ OutputImageTile2dConstPtr

typedef boost::shared_ptr<const OutputImageTile2d> ipsdk::image::OutputImageTile2dConstPtr

shared pointer to OutputImageTile2d

◆ ImageTile3dPtr

typedef boost::shared_ptr<BaseImageTile3d> ipsdk::image::ImageTile3dPtr

shared pointer to BaseImageTile3d

◆ ImageTile3dConstPtr

typedef boost::shared_ptr<const BaseImageTile3d> ipsdk::image::ImageTile3dConstPtr

shared pointer to BaseImageTile3d

◆ InputImageTile3dPtr

typedef boost::shared_ptr<InputImageTile3d> ipsdk::image::InputImageTile3dPtr

shared pointer to InputImageTile3d

◆ InputImageTile3dConstPtr

typedef boost::shared_ptr<const InputImageTile3d> ipsdk::image::InputImageTile3dConstPtr

shared pointer to InputImageTile3d

◆ InOutImageTile3dPtr

typedef boost::shared_ptr<InOutImageTile3d> ipsdk::image::InOutImageTile3dPtr

shared pointer to InOutImageTile3d

◆ InOutImageTile3dConstPtr

typedef boost::shared_ptr<const InOutImageTile3d> ipsdk::image::InOutImageTile3dConstPtr

shared pointer to InOutImageTile3d

◆ OutputImageTile3dPtr

typedef boost::shared_ptr<OutputImageTile3d> ipsdk::image::OutputImageTile3dPtr

shared pointer to OutputImageTile3d

◆ OutputImageTile3dConstPtr

typedef boost::shared_ptr<const OutputImageTile3d> ipsdk::image::OutputImageTile3dConstPtr

shared pointer to OutputImageTile3d

◆ DistributedImagePtr

typedef boost::shared_ptr< DistributedImage > ipsdk::image::DistributedImagePtr

shared pointer to distributed image

shared pointer to DistributedImage

◆ DistributedImageConstPtr

typedef boost::shared_ptr< const DistributedImage > ipsdk::image::DistributedImageConstPtr

shared pointer to distributed image

shared pointer to DistributedImage

◆ DistributedImageWeakPtr

typedef boost::weak_ptr<DistributedImage> ipsdk::image::DistributedImageWeakPtr

weak pointer to distributed image

◆ DistributedImageConstWeakPtr

typedef boost::weak_ptr<const DistributedImage> ipsdk::image::DistributedImageConstWeakPtr

weak pointer to distributed image

◆ ImagePtr

typedef boost::shared_ptr<BaseImage> ipsdk::image::ImagePtr

shared pointer to image

◆ ImageConstPtr

typedef boost::shared_ptr<const BaseImage> ipsdk::image::ImageConstPtr

shared pointer to image

◆ ImageWeakPtr

typedef boost::weak_ptr<BaseImage> ipsdk::image::ImageWeakPtr

weak pointer to image

◆ ImageConstWeakPtr

typedef boost::weak_ptr<const BaseImage> ipsdk::image::ImageConstWeakPtr

weak pointer to image

◆ DiskImagePtr

typedef boost::shared_ptr<DiskImage> ipsdk::image::DiskImagePtr

shared pointer to DiskImage

◆ DiskImageConstPtr

typedef boost::shared_ptr<const DiskImage> ipsdk::image::DiskImageConstPtr

shared pointer to DiskImage

◆ MemoryImagePtr

typedef boost::shared_ptr<MemoryImage> ipsdk::image::MemoryImagePtr

shared pointer to MemoryImage

◆ MemoryImageConstPtr

typedef boost::shared_ptr<const MemoryImage> ipsdk::image::MemoryImageConstPtr

shared pointer to MemoryImage

◆ UserImagePtr

typedef boost::shared_ptr<UserImage> ipsdk::image::UserImagePtr

shared pointer to UserImage

◆ UserImageConstPtr

typedef boost::shared_ptr<const UserImage> ipsdk::image::UserImageConstPtr

shared pointer to UserImage

◆ CudaImagePtr

typedef boost::shared_ptr<CudaImage> ipsdk::image::CudaImagePtr

shared pointer to CudaImage

◆ CudaImageConstPtr

typedef boost::shared_ptr<const CudaImage> ipsdk::image::CudaImageConstPtr

shared pointer to CudaImage

◆ PlanStorageColl1d

typedef std::vector<PlanStoragePtr> ipsdk::image::PlanStorageColl1d

1d collection of plan storage

◆ PlanStorageConstColl1d

typedef std::vector<PlanStorageConstPtr> ipsdk::image::PlanStorageConstColl1d

1d collection of plan storage

◆ PlanStorageColl2d

typedef std::vector<PlanStorageColl1d> ipsdk::image::PlanStorageColl2d

2d collection of plan storage

◆ PlanStorageConstColl2d

typedef std::vector<PlanStorageConstColl1d> ipsdk::image::PlanStorageConstColl2d

2d collection of plan storage

◆ PlanStorageColl3d

typedef std::vector<PlanStorageColl2d> ipsdk::image::PlanStorageColl3d

3d collection of plan storage

◆ PlanStorageConstColl3d

typedef std::vector<PlanStorageConstColl2d> ipsdk::image::PlanStorageConstColl3d

3d collection of plan storage

Enumeration Type Documentation

◆ eImageAccessorMessage

enum ipsdk::image::eImageAccessorMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eImageAccessorNoPlanAccess	No direct memory access for image s and plan z=d, c=d and t=d.
eImageAccessorNotInit	Initialize image accessor before trying to use its data.
eImageAccessorWriteNotAllowed	Can't write image s, write access mode not allowed.
eImageAccessorResizeNotAllowed	Can't resize image s, resize access mode not allowed.
eImageAccessorResizeFailed	Failed to resize image s s.
eInvalidZCTPlanIndex	Plan index z=d c=d t=d is not valid given image geometry.
eWrongIm6MagicNumber	The magic number value must be 0x00006935.
eCreateFileFailed	Failed to create disk image file s.
eCreateFileFailedWin32	Failed to create disk image file s s.
eReserveSpaceFailed	Failed to reserve lld bytes for disk image file s.
eReserveSpaceFailedWin32	Failed to reserve lld bytes for disk image file s s.
eInvalidPlanIdx	Invalid plan component indexes z=d c=d t=d.
eSeekFailed	Failed to seek position into disk image file s for z=d, c=d, t=d and pixelStartOffset=lld.
eReadFailed	Failed to read disk image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eWriteFailed	Failed to write disk image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eWriteFailedWin32	Failed to write disk image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld s.
eOpenFileFailed	Failed to open disk image file s.
eGeometryGreaterThanFileSize	Input geometry with total size lld is greater than global file size lld for disk image file s.
eErrorDiskImgePathDoesNotExist	The image path s does not exists.
eErrorCantRemoveDiskImgeFile	Could not remove the disk image file s : s.

◆ eBorder2dMessage

enum ipsdk::image::eBorder2dMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eNotInit	Border policy has not been initialized, can't access its data.
eCantGetValuedType	Can't get valued type for border policy with type s.
eCantGetFillValue	Can't get fill value for border policy with valued type s.
eCantGetTheta	Can't get theta for border policy with type s.

◆ eBorder2dType

enum ipsdk::image::eBorder2dType

Enumerate describing image data preparator 2d border type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eB2DT_Valued	Border values set to a constant given value.
eB2DT_Continue	Border values extended by direct continuity.
eB2DT_Miror	Border values extended mirroring existing data.
eB2DT_LinearContinue	Border values extended linearly continuing
eB2DT_LinearMiror	existing data using a given direction Border values extended linearly mirroring

◆ eValuedBorder2dType

enum ipsdk::image::eValuedBorder2dType

Enumerate describing valued border 2d used value type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eVB2DT_Custom	Used value for valued border 2d extension is provided by user.
eVB2DT_Min	Used value for valued border 2d extension is set to minimum buffer type value.
eVB2DT_Max	Used value for valued border 2d extension is set to maximum buffer type value.

◆ eBorder3dMessage

enum ipsdk::image::eBorder3dMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eNotInit	Border policy has not been initialized, can't access its data.
eCantGetValuedType	Can't get valued type for border policy with type s.
eCantGetFillValue	Can't get fill value for border policy with valued type s.

◆ eBorder3dType

enum ipsdk::image::eBorder3dType

Enumerate describing image data preparator 3d border type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eB3DT_Valued	Border values set to a constant given value.
eB3DT_Continue	Border values extended by direct continuity.
eB3DT_Miror	Border values extended mirroring existing data.

◆ eValuedBorder3dType

enum ipsdk::image::eValuedBorder3dType

Enumerate describing valued border 3d used value type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eVB3DT_Custom	Used value for valued border 3d extension is provided by user.
eVB3DT_Min	Used value for valued border 3d extension is set to minimum buffer type value.
eVB3DT_Max	Used value for valued border 3d extension is set to maximum buffer type value.

◆ eImageFragmentExtractorMessage

enum ipsdk::image::eImageFragmentExtractorMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eCantExtract3dStrip	Image is not a 3d image, can't extract a 3d strip.
eCantExtract3dSubImage	Image is not a 3d image, can't extract a 3d sub image.
eCantExtractColorStrip	Image is not a color image, can't extract a color strip.
eCantExtractColorSubImage	Image is not a color image, can't extract a color sub image.
eCantExtractSequenceSubImage	Image is not a sequence image, can't extract a sequence sub image.
eCantExtractTemporalStrip	Image is not a sequence image, can't extract a temporal strip.
eCantReInterpretImageData	Input image data cannot be reinterpreted according to target image geometry.
eColorGeometryTypeMismatch	Color geometry type mismatch between input image 1 and input image 2 (s!=s)
eDataTypeMismatch	Data type mismatch between sequence elements #d of image #1 and image #d (s!=s)
eFailedToCreateReInterpretedSubImage	Failed to create reinterpreted sub image s.
eFailedToCreateTemporalStrip	Failed to create temporal strip associated to temporal plan d s.
eInvalidCPlanIndex	Plan index c=d is not valid given image geometry.
eInvalidCTPlanIndex	Plan index c=d t=d is not valid given image geometry.
eInvalidDeviceIndex	Device index d is not valid.
eInvalidEndingKernelSizeX	Ending kernel size X d is greater than input image X size d.
eInvalidEndingKernelSizeY	Ending kernel size Y d is greater than input image Y size d.
eInvalidEndingKernelSizeZ	Ending kernel size Z d is greater than input image Z size d.
eInvalidImageCCoord	Coordinate c=d is invalid for image (with c size d)
eInvalidImageTCoord	Coordinate t=d is invalid for image (with t size d)
eInvalidImageXCoord	Coordinate x=d is invalid for image (with x size d)
eInvalidImageYCoord	Coordinate y=d is invalid for image (with y size d)
eInvalidImageZCoord	Coordinate z=d is invalid for image (with z size d)
eInvalidNextXStrip2dSizeX	Next x strip 2d X size d is greater than Half kernel X size d.
eInvalidNextXStrip2dSizeY	Next x strip 2d Y size d is not equal to input image Y size d.
eInvalidNextYStrip2dSizeX	Next y strip 2d X size d is not equal to input image X size d.
eInvalidNextYStrip2dSizeY	Next y strip 2d Y size d is greater than Half kernel Y size d.
eInvalidNextZStrip3dSizeX	Next z strip 3d X size d is not equal to input image X size d.
eInvalidNextZStrip3dSizeY	Next z strip 3d Y size d is not equal to input image Y size d.
eInvalidNextZStrip3dSizeZ	Next z strip 3d Z size d is greater than Half kernel Z size d.
eInvalidPreviousXStrip2dSizeX	Previous x strip 2d X size d is not equal to half kernel X size d.
eInvalidPreviousXStrip2dSizeY	Previous x strip 2d Y size d is greater than input image Y size d.
eInvalidPreviousYStrip2dSizeX	Previous y strip 2d X size d is not equal to input image X size d.
eInvalidPreviousYStrip2dSizeY	Previous y strip 2d Y size d is greater than Half kernel Y size d.
eInvalidPreviousZStrip3dSizeX	Previous z strip 3d X size d is not equal to input image X size d.
eInvalidPreviousZStrip3dSizeY	Previous z strip 3d Y size d is not equal to input image Y size d.
eInvalidPreviousZStrip3dSizeZ	Previous z strip 3d Z size d is greater than Half kernel Z size d.
eInvalidStartingKernelSizeX	Starting kernel size X d is greater than input image X size d.
eInvalidStartingKernelSizeY	Starting kernel size Y d is greater than input image Y size d.
eInvalidStartingKernelSizeZ	Starting kernel size Z d is greater than input image Z size d.
eInvalidTPlanIndex	Plan index t=d is not valid given image geometry.
eInvalidTemporalCoords	Invalid temporal coordinates (start offset d and size d), for global image size d.
eInvalidTemporalSize	Invalid temporal size, should not be null.
eInvalidXStrip2dEndingOffsetX	Ending x strip 2d X starting offset d is different from provided main ending X offset d.
eInvalidXStrip2dStartingOffsetX	Starting x strip 2d X ending offset d is different from provided main starting X offset d.
eInvalidXStripCoords	Image strip splitted along x axis with starting offset d and size d is not valid regards to image x size d.
eInvalidYStrip2dEndingOffsetY	Ending y strip 2d Y starting offset d is different of provided main ending Y offset d.
eInvalidYStrip2dStartingOffsetY	Starting y strip 2d Y ending offset d is different of provided main starting Y offset d.
eInvalidYStripCoords	Image strip splitted along y axis with starting offset d and size d is not valid regards to image y size d.
eInvalidZCPlanIndex	Plan index z=d c=d is not valid given image geometry.
eInvalidZCTPlanIndex	Plan index z=d c=d t=d is not valid given image geometry.
eInvalidZPlanIndex	Plan index z=d is not valid given image geometry.
eInvalidZRange	z range (offset=d, size=d) is not valid given image geometry
eInvalidZStrip3dEndingOffsetZ	Ending z strip 3d Z starting offset d is different of provided main ending Z offset d.
eInvalidZStrip3dStartingOffsetZ	Starting z strip 3d Z ending offset d is different of provided main starting Z offset d.
eInvalidZStripCoords	Image strip splitted along z axis with starting offset d and size d is not valid regards to image z size d.
eInvalidZTPlanIndex	Plan index z=d t=d is not valid given image geometry.
eNbImagesInCollShouldBeGreaterThanOne	Number of images in collection (d) should be greater than one.
eNullFragmentSize	Null fragment size are not allowed.
eSizeCMismatch	SizeC mismatch between input image #1 and input image #d (d!=d)
eSizeXMismatch	SizeX mismatch between input image #1 and input image #d (d!=d)
eSizeYMismatch	SizeY mismatch between input image #1 and input image #d (d!=d)
eSizeTMismatch	SizeT mismatch between input image #1 and input image #d (d!=d)
eSizeZMismatch	SizeZ mismatch between input image #1 and input image #d (d!=d)
eVolumeGeometryTypeMismatch	Volume geometry type mismatch between input image #1 and input image #d (s!=s)

◆ eImageFragmentMessage

enum ipsdk::image::eImageFragmentMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eImageFragmentBufferNotInit	Can't access to image fragment buffer, not initialized.
eImageFragmentNoDataAccess	Can't access to image data.
eImageFragmentNotInit	Initialize image fragment before trying to use its data.
eImageWriteNotGranted	Image write is not granted, can't generate a writable fragment.
eInvalidImageCPlanIndex	Provided color plan index d is not valid given color strip size d.
eInvalidImageZPlanIndex	Provided z plan index d is not valid given z strip size d.
eMemoryAllocationFailed	Failed to allocate memory with size lld and type s s.
eNullInputSharedPtr	Input shared pointer should not be null.
eFailedToCreateColorVolumeStrip	Failed to create color volume strip associated to color plan d s.

◆ eImageFragmentType

enum ipsdk::image::eImageFragmentType

Enumerate describing image fragment type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIFT_ImageStrip	Image strip fragment.
eIFT_ImageTile	Image tile fragment.

◆ eDataAccessMode

enum ipsdk::image::eDataAccessMode

Enumerate describing access mode for an image fragment data.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eDAM_LocalMemory	Image data are directly accessed through local memory
eDAM_LocalDisk	This is the case for : - local memory image user image with direct row data access Image data are indirectly accessed via
eDAM_SharedDisk	private local storage (not shared on network) This is the case for : local disk data user image without direct row data access Image data are indirectly accessed via
eDAM_LocalFragment	network shared storage This is the case for : shared disk data Image data are directly accessed via
eDAM_RemoteFragment	shared local storage (shared on network) This is the case for : local image fragment Image data are accessed via
eDAM_NoAccess	shared remote storage (shared on network) This is the case for : remote image fragment Image data are stored into an unaccesible remote storage

◆ eImageStripMessage

enum ipsdk::image::eImageStripMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eEmptyTemporalColl	Temporal collection size d mismatch with expected number of plans d for image strip initialization.
eEmptyVolumeColl	Empty volume collections are not allowed for strip initialization.
eInvalidColorCollSize	Color collection size d mismatch with provided color geometry size d for strip initialization.
eInvalidStripCCoord	Coordinate c=d is invalid for strip (with c size d)
eInvalidStripTCoord	Coordinate t=d is invalid for strip (with t size d)
eInvalidStripXCoord	Coordinate x=d is invalid for strip (with x size d)
eInvalidStripYCoord	Coordinate y=d is invalid for strip (with y size d)
eInvalidStripZCoord	Coordinate z=d is invalid for strip (with z size d)
eInvalidStripZRange	Invalid range z [d, d] for image strip for image with z size d.
eInvalidVolumeCollSize	Volume collection size d mismatch with expected number of plans d for image strip initialization.
eMixedStripDistributedPlanStorage	Strip data can't mix distributed and non distributed plan storage types.
eNonHomogeneousAccessMode	Data access mode is not homogeneous among plan storage collection, found s and s.
eNullStripPtr	Input strip shared pointer should not be null.

◆ eImageStripType

enum ipsdk::image::eImageStripType

Enumerate describing image strip type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIST_X2d	image 2d strip with splitting along X axis
eIST_Y2d	image 2d strip with splitting along Y axis
eIST_X2dWithKernel	image 2d strip with splitting along X axis associated to a kernel
eIST_Y2dWithKernel	image 2d strip with splitting along Y axis associated to a kernel
eIST_Y3d	image 3d strip with splitting along Y axis
eIST_YColor2d	color image 2d strip with splitting along Y axis
eIST_YSeq2d	sequence image 2d strip with splitting along Y axis
eIST_Z3d	image 3d strip with splitting along Z axis
eIST_Z3dWithKernel	image 3d strip with splitting along Z axis associated to a kernel
eIST_ZColor3d	color image 3d strip with splitting along Z axis

◆ eStripParsingDirection

enum ipsdk::image::eStripParsingDirection

Enumerate describing strip parsing direction.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator

eSPD_Direct

direct strip parsing direction (default behavior)

Top to bottom strip parsing

eSPD_Reverse

reverse strip parsing direction

Bottom to top strip parsing

◆ eStripAllocationType

enum ipsdk::image::eStripAllocationType

Enumerate describing image strip allocation policy.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator

eSAT_NoAllocation

Do not force any allocation (standard case)

Force allocation of strip data

eSAT_InSitu

In case of kernel processing this flag force allocation of :

strip main data
strip border data used for kernel processing

◆ eImageTileMessage

enum ipsdk::image::eImageTileMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eInvalidTileEndOffsetX	Invalid tile end offset x coordinate d for image with x size d.
eInvalidTileEndOffsetY	Invalid tile end offset y coordinate d for image with y size d.
eInvalidTileEndOffsetZ	Invalid tile end offset z coordinate d for image with z size d.
eInvalidTileRangeX	Invalid tile x range with start coordinate d and size d for image with x size d.
eInvalidTileRangeY	Invalid tile y range with start coordinate d and size d for image with y size d.
eInvalidTileRangeZ	Invalid tile z range with start coordinate d and size d for image with z size d.
eInvalidTileYCoord	Row coordinate d is not valid given tile y size d.
eInvalidTileZCoord	Coordinate z=d is invalid for tile (with z size d)
eNonHomogeneousAccessMode	Data access mode is not homogeneous among plan storage collection, found s and s.
eUnsupportedBorderPolicy	Border policy s is not supported for border processing.
eUnsupportedImageBufferType	Image buffer type s is not supported for border processing.

◆ eImageTileType

enum ipsdk::image::eImageTileType

Enumerate describing image tile type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eITT_2d	image 2d tile
eITT_3d	image 3d tile

◆ eGeometryComponentMessage

enum ipsdk::image::eGeometryComponentMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eColorGeometryNotInit	Initialize color geometry before trying to use it.
eNotColorSpaceConversionKnown	Color conversion between s color space and s color space is not (yet) known.
eNullColorSize	Invalid image color size, should not be null.
eNullSequenceSize	Invalid image sequence size, should not be null.
eNullVolumeSize	Invalid image volume size, should not be null.
eTemporalGeometryNotInit	Initialize temporal geometry before trying to use it.
eUnSupportedEnumValue	Enumerate value s is not yet supported.
eUnknownColorSize	Number of color plans associated to color geometry type s is not defined.
eVolumeGeometryNotInit	Initialize volume geometry before trying to use it.
eBadColorChannelIndex	Channel index d exceeds the number of channels.
eBadVolumeGeometryType	Bad volume geometry type s because sizeZ = ld != 1.
eBadColorGeometryType	Bad color geometry type s for sizeC = ld.
eBadTemporalGeometryType	Bad temporal geometry type s because sizeT = ld != 1.

◆ eGeometryMessage

enum ipsdk::image::eGeometryMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eImageGeometryNotInit	Initialize image geometry before trying to use it.
eInvalidGeometryTPlanIndex	Geometry t plan index d is not valid given image geometry.
eInvalidImageBufferType	Empty image buffer type geometry definition is invalid. Invalid image buffer type enum value d. Empty image buffer type plan geometry definition is invalid.
eTSizeAndBufferTypeCollSizeMismatch	Image geometry temporal size d and image buffer type collection size s mismatch.

◆ ePlanGeometryMessage

enum ipsdk::image::ePlanGeometryMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator

ePlanGeometryNotInit

Initialize plan geometry before trying to use it.

eInvalidImageBufferType

Empty image buffer type geometry definition is invalid.

Invalid image buffer type enum value d.

Empty image buffer type plan geometry definition is invalid.

◆ eImageMessage

enum ipsdk::image::eImageMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eBaseNotShared	Can't initialize an image not created from a shared pointer for image with guid s.
eBinaryWithout8BitsSupportNotReInterpretable	Binary images without 8 bits support are not re interpretable. Binary plan storage without 8 bits support are not re interpretable.
eDiskImageNullAccessor	Disk image accessor shared pointer should not be null.
eDistributedImageInitFailed	Failed to initialize distributed image with size lld s.
eDistributedImageResizeFailed	Failed to resize distributed image with size lld s.
eEmptyImageBufferType	Can't retrieve buffer value associated to an image buffer type equal to eImageBufferType::eIBT_None.
eErrorDeviceIndex	Invalid device index d.
eFailedCreateImage	Image creation failed s.
eFailedToCreatePlan	Failed to create image plan z=d c=d t=d s.
eFailedToResizePlan	Failed to resize image plan z=d c=d t=d s.
eFailedToResizeGpuPlan	Failed to resize GPU image plan (device=d) s.
eHeterogeneousNotReInterpretable	Images with heterogeneous buffer type are not re interpretable.
eImageNameFormatFull	s {s}
eImageNameFormatGuid	{s}
eImageNameFormatName	s
eImageNotInit	Initialize image before trying to use its data.
eInvalidImageBufferType	Empty image buffer type geometry definition is invalid. Invalid image buffer type enum value d. Empty image buffer type plan geometry definition is invalid.
eInvalidImageNameFormat	Invalid image name format enum value d.
eInvalidPlanIndex	Invalid plan index {z=d, c=d, t=d} given image size {sizeZ=d, sizeC=d, sizeT=d}.
eMemoryImageInitFailed	Failed to initialize memory image with size lld s.
eGpuImageInitFailed	Failed to initialize GPU image with size lld s.
eMemoryImageResizeFailed	Failed to resize memory image with size lld s.
eGpuImageResizeFailed	Failed to resize GPU image with size lld s.
eMismatchingBaseMemorySizeNotReInterpretable	Original image with s buffer type cannot be reinterpreted to s buffer type (base memory size mismatch) Original plan storage with s buffer type cannot be reinterpreted to s buffer type (base memory size mismatch)
eNbPlansNotReInterpretable	Original image with d plans cannot be reinterpreted to d plans.
eNotGeometricCalibration	Image is not associated to a geometric calibration, can't retrieve it.
ePixelsByPlansNotReInterpretable	Original image with d pixels by plans cannot be reinterpreted to d pixels by plans.
eResizeImageNotGranted	Can't resize image, resize access mode not granted.
eUnNamedImageName	UnNamedImage.
eUserImageNullAccessor	User image accessor shared pointer should not be null.
eErrorInputImageNotInitilized	The buffer can not be extracted because the input image is not initialized.
eErrorBadSizeY	The buffer can not be extracted because the user specified an Y size of of whereas the input image has d lines.
eErrorbadIndexC	The buffer can not be extracted because the user wanted to extract the dth color plan whereas the image has d channels.
eErrorbadIndexT	The buffer can not be extracted because the user wanted to extract the dth temporal plan whereas the image has d frames.
eErrorCantCopyImgToGpuWithoutGpuSupport	Can not copy the image to GPU because the GPU support is not activated.
eNullCpuBuffer	Can not copy the image to GPU because the CPU plan {z=d, c=d, t=d} is NULL.
eCantLoadPlanFromMemory	Can not load a plan from a disk image : s.
eBadBufferType	[DiskImage::readPixel] bad image buffer type s
eCantReadPixelValue	Can read pixel value from a disk image : s.

◆ eImageBaseType

enum ipsdk::image::eImageBaseType

Enumerate describing image base type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIBT_Complete	complete image
eIBT_Sub	sub image of a complete image

◆ eImageType

enum ipsdk::image::eImageType

Enumerate describing image type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIT_Memory	memory image
eIT_Disk	disk image
eIT_User	user image
eIT_Gpu	GPU image.
eIT_Distributed	distributed image (potentially hold by remote computers)
eIT_Custom	specific images for dedicated tasks

◆ eImageBufferType

enum ipsdk::image::eImageBufferType

types associated to image buffers

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIBT_None	empty buffer type
eIBT_Int8	char buffers
eIBT_UInt8	unsigned char buffers
eIBT_Int16	short buffers
eIBT_UInt16	unsigned short buffers
eIBT_Int32	int buffers
eIBT_UInt32	unsigned int buffers
eIBT_Real32	float buffers
eIBT_Binary	binary buffers
eIBT_Label16	label, 16 bits buffers
eIBT_Label32	label, 32 bits buffers
eIBT_Label8	label, 8 bits buffers

◆ eImageAccessMode

enum ipsdk::image::eImageAccessMode

Image access mode.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eIAM_Read	read only access mode for image
eIAM_Write	read/write access mode for image
eIAM_Resize	read/write/resize access mode for image

◆ eFormatedType

enum ipsdk::image::eFormatedType

Type for generation of formated image name.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
eFT_Full	Full image formated name (default : Name {Guid})
eFT_Name	Name only formated name (default : Name)
eFT_Guid	Guid only formated name (default : {Guid})

◆ eIPSDKImageMessage

enum ipsdk::image::eIPSDKImageMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eErrorCreateCpuFromGpu	Can not create CPU image from GPU.
eErrorCantCopyBufferFromGpuToCpu	Can not copy the buffer from GPU to CPU with type s.
eErrorCantCopyBufferFromGpuToCpuGeomMismatch	Can not copy the buffer from GPU to CPU, geometries mismatch.
eDifferentBufferBaseSize	Can't convert image with buffer type s to s : Base buffer size mismatch.
eWarnObsolete	s is obsolete, please use s instead

◆ ePlanStorageMessage

enum ipsdk::image::ePlanStorageMessage

Enumerate describing messages.

Note: This enumerate is associated to a message map

See also: IPSDK_Message_Map

Enumerator
eBinaryWithout8BitsSupportNotReInterpretable	Binary images without 8 bits support are not re interpretable. Binary plan storage without 8 bits support are not re interpretable.
eCantReInterpretStorage	Plan storage geometry [sizeX=d, sizeY=d, bufferType=s] can't be reinterpreted as [sizeX=d, sizeY=d, bufferType=s].
eCantResizeDiskPlan	Can't directly resize disk image plan, please resize full image.
eCantResizeDistributedPlan	Can't directly resize dsitributed image plan, please resize full image.
eCantResizeReInterpretedPlan	Can't resize re interpreted image plan.
eCantResizeUserPlan	Can't directly resize user image plan, please resize image.
eInvalidDataOffset	Data offsets (startOffset=lld, size=lld) are not valid for image plan i/o operation given number pixel lld.
eInvalidDataOffsetX	Data x offsets (startOffsetX=d, sizeX=d) are not valid for image plan i/o operation given x size d.
eInvalidDataOffsetY	Data y offsets (startOffsetY=d, sizeY=d) are not valid for image plan i/o operation given y size d.
eInvalidLocationMapData	Invalid location map data for distributed plan storage, strip data are not contiguous, for image guid d and plan index {z=d, c=d, t=d}.
eInvalidYCoords	Invalid y coordinates d for plan storage with size y d.
eLocationMapAndGeometryMismatch	Location map data mismatch with provided plan geometry for distributed plan storage, for image guid d and plan index {z=d, c=d, t=d}.
eMemoryAllocationFailed	Failed to allocate memory with size lld and type s s.
eMismatchingBaseMemorySizeNotReInterpretable	Original image with s buffer type cannot be reinterpreted to s buffer type (base memory size mismatch) Original plan storage with s buffer type cannot be reinterpreted to s buffer type (base memory size mismatch)
eNbPixelsNotReInterpretable	Original plan storage with d pixels cannot be reinterpreted to d pixels.
eNullImageIdentifier	Image identifer shared pointer should not be null for distributed strip manager initialization.
ePlanStorageNotInit	Initialize plan storage before trying to use its data.
eResizeFailed	Failed to resize plan storage s.

◆ ePlanStorageType

enum ipsdk::image::ePlanStorageType

Enumerate describing plan storage type.

Note: This object is associated to a strong enumerate definition

See also: IPSDK_Enum

Enumerator
ePST_Memory	memory plan storage
ePST_Disk	disk plan storage
ePST_User	user plan storage
ePST_Distributed	distributed plan storage (potentially hold by remote computers)
ePST_ReInterpreted	re interpreted virtual plan storage associated to a real plan storage
ePST_Gpu	GPU plan storage.
ePST_Custom	specific plan storage for dedicated task

Function Documentation

◆ reInterpretImageData()

IPSDKIMAGE_API ImagePtr ipsdk::image::reInterpretImageData	(	const ImagePtr &	pOriginalImage,
		const BaseImageGeometry &	targetGeometry
	)

function allowing to create a reinterpreted version of an image

Exceptions

ipsdk::image::IPSDKImageException if canBeReInterpreted(originalImage, targetGeometry) == false

Returns: input image if suitable or reinterpreted sub image otherwise

◆ getFormatedName() [1/2]

IPSDKIMAGE_API std::string ipsdk::image::getFormatedName	(	const BaseImageFragment &	fragment,
		const eFormatedType &	formatedType = `eFormatedType::eFT_Full`
	)

format image name associated to fragment for display

Exceptions

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

◆ retrieveDataAccessMode() [1/2]

IPSDKIMAGE_API eDataAccessMode ipsdk::image::retrieveDataAccessMode ( const PlanStorageConstPtr & pPlanStorage )

retrieve data access mode associated to a plan storage for full plan data

◆ retrieveDataAccessMode() [2/2]

IPSDKIMAGE_API eDataAccessMode ipsdk::image::retrieveDataAccessMode	(	const PlanStorageConstPtr &	pPlanStorage,
		const ipUInt64	startOffsetY,
		const ipUInt64	sizeY
	)

retrieve data access mode associated to a plan storage and given row coordinates

◆ geometryColor()

IPSDKIMAGE_API ColorGeometry ipsdk::image::geometryColor ( const eColorGeometryType & colorGeometryType )

create a color geometry associated to a given color space

Exceptions

ipsdk::image::IPSDKImageException if getColorGeometrySize(colorGeometryType) == 0

◆ COLORGEOMETRYTYPE_TO_SIZE() [1/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_Grey	,
		1
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [2/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_Rgb	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [3/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_Rgba	,
		4
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [4/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_XYZ	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [5/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_YPbPr	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [6/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_YCbCr	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [7/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_CieLab	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [8/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_CieLuv	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [9/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_HLS	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [10/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_HSV	,
		3
	)

structures implementation

◆ COLORGEOMETRYTYPE_TO_SIZE() [11/11]

ipsdk::image::COLORGEOMETRYTYPE_TO_SIZE	(	eCGT_User	,
		0
	)

structures implementation

◆ isEqual() [1/4]

IPSDKIMAGE_API bool ipsdk::image::isEqual	(	const VolumeGeometry &	volumeGeometry1,
		const VolumeGeometry &	volumeGeometry2
	)

compare two volume geometry

Exceptions

ipsdk::image::IPSDKImageException	if volumeGeometry1.isInit() == false
ipsdk::image::IPSDKImageException	if volumeGeometry2.isInit() == false

◆ isEqual() [2/4]

IPSDKIMAGE_API bool ipsdk::image::isEqual	(	const ColorGeometry &	colorGeometry1,
		const ColorGeometry &	colorGeometry2
	)

compare two color geometry

Exceptions

ipsdk::image::IPSDKImageException	if colorGeometry1.isInit() == false
ipsdk::image::IPSDKImageException	if colorGeometry2.isInit() == false

◆ isEqual() [3/4]

IPSDKIMAGE_API bool ipsdk::image::isEqual	(	const TemporalGeometry &	temporalGeometry1,
		const TemporalGeometry &	temporalGeometry2
	)

compare two temporal geometry

Exceptions

ipsdk::image::IPSDKImageException	if temporalGeometry1.isInit() == false
ipsdk::image::IPSDKImageException	if temporalGeometry2.isInit() == false

◆ isEqual() [4/4]

IPSDKIMAGE_API bool ipsdk::image::isEqual	(	const ImagePlanGeometry &	planGeometry1,
		const ImagePlanGeometry &	planGeometry2
	)

compare two image plan geometry

Exceptions

ipsdk::image::IPSDKImageException	if planGeometry1.isInit() == false
ipsdk::image::IPSDKImageException	if planGeometry2.isInit() == false

◆ IMAGETYPE_TO_BUFFER_STRUCT() [1/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Int8	,
		ipInt8
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [2/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_UInt8	,
		ipUInt8
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [3/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Int16	,
		ipInt16
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [4/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_UInt16	,
		ipUInt16
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [5/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Int32	,
		ipInt32
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [6/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_UInt32	,
		ipUInt32
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [7/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Real32	,
		ipReal32
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [8/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Binary	,
		ipUInt8
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [9/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Label16	,
		ipUInt16
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [10/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Label32	,
		ipUInt32
	)

structures implementation

◆ IMAGETYPE_TO_BUFFER_STRUCT() [11/11]

ipsdk::image::IMAGETYPE_TO_BUFFER_STRUCT	(	eIBT_Label8	,
		ipUInt8
	)

structures implementation

◆ getFormatedName() [2/2]

IPSDKIMAGE_API std::string ipsdk::image::getFormatedName	(	const BaseImage &	image,
		const eFormatedType &	formatedType = `eFormatedType::eFT_Full`
	)

format image name for display

Exceptions

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

◆ getMinValue()

IPSDKIMAGE_API ipReal64 ipsdk::image::getMinValue ( const eImageBufferType & imageBufferType )

retrieve minimum value for a given image buffer type

Exceptions

ipsdk::image::IPSDKImageException if imageBufferType == eImageBufferType::eIBT_None

◆ getMaxValue()

IPSDKIMAGE_API ipReal64 ipsdk::image::getMaxValue ( const eImageBufferType & imageBufferType )

retrieve maximum value for a given image buffer type

Exceptions

ipsdk::image::IPSDKImageException if imageBufferType == eImageBufferType::eIBT_None

◆ canBeReInterpreted() [1/2]

IPSDKIMAGE_API BoolResult ipsdk::image::canBeReInterpreted	(	const BaseImage &	originalImage,
		const BaseImageGeometry &	targetGeometry
	)

fonction allowing to check whether data of an image can be re interpreted with a different geometry. This allows for example reuse of working images for different usages.

To be reinterpretable :

target plan number of pixels should be lower or equal to original
target total number of plans should be lower or equal to original
target data base size should be equal to original one
images with heterogeneous data type cannot be reinterpreted
binary images without 8 bits support cannot be reinterpreted
Exceptions

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

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

◆ extractBufferFromConstImage()

template<typename T >

IPSDKIMAGE_API const T* ipsdk::image::extractBufferFromConstImage	(	const BaseImage &	inImg,
		const ipUInt64	sizeY,
		const ipUInt64	z = `0`,
		const ipUInt64	c = `0`,
		const ipUInt64	t = `0`
	)

function allowing to retrieve the buffer of a constant image plan

Exceptions

ipsdk::image::IPSDKImageException	if pInImg.isInit() == false
ipsdk::image::IPSDKImageException	if sizeY < 1
ipsdk::image::IPSDKImageException	if on failure

◆ extractBufferFromImage()

template<typename T >

IPSDKIMAGE_API T* ipsdk::image::extractBufferFromImage	(	BaseImage &	inImg,
		const ipUInt64	sizeY,
		const ipUInt64	z = `0`,
		const ipUInt64	c = `0`,
		const ipUInt64	t = `0`
	)

function allowing to retrieve the buffer of an image plan

Exceptions

ipsdk::image::IPSDKImageException	if pInImg.isInit() == false
ipsdk::image::IPSDKImageException	if sizeY < 1
ipsdk::image::IPSDKImageException	if on failure

◆ canBeReInterpreted() [2/2]

IPSDKIMAGE_API BoolResult ipsdk::image::canBeReInterpreted	(	const BasePlanStorage &	originalPlanStorage,
		const ImagePlanGeometry &	targetPlanGeometry
	)

fonction allowing to check whether a plan storage can be re interpreted with a different geometry. This allows for example reuse of working images for different usages.

To be reinterpretable :

target plan number of pixels should be lower or equal to original
target data base size should be equal to original one
binary data type without 8 bits support cannot be reinterpreted
Exceptions

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

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

ipsdk::image::IPSDKImageException	if originalImage.isInit() == false
ipsdk::image::IPSDKImageException	if targetGeometry.isInit() == false

ipsdk::image::IPSDKImageException	if originalPlanStorage.isInit() == false
ipsdk::image::IPSDKImageException	if targetPlanGeometry.isInit() == false

Namespaces

Classes

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ ImageStripPtr

◆ ImageStripConstPtr

◆ ImageXStrip2dPtr

◆ ImageXStrip2dConstPtr

◆ ImageYStrip2dPtr

◆ ImageYStrip2dConstPtr

◆ ImageYStrip2dWithKernelPtr

◆ ImageYStrip2dWithKernelConstPtr

◆ ImageYStrip3dPtr

◆ ImageYStrip3dConstPtr

◆ ImageYStripColor2dPtr

◆ ImageYStripColor2dConstPtr

◆ ImageYStripSeq2dPtr

◆ ImageYStripSeq2dConstPtr

◆ ImageZStrip3dPtr

◆ ImageZStrip3dConstPtr

◆ ImageZStrip3dWithKernelPtr

◆ ImageZStrip3dWithKernelConstPtr

◆ ImageTilePtr

◆ ImageTileConstPtr

◆ ImageTile2dPtr

◆ ImageTile2dConstPtr

◆ InputImageTile2dPtr

◆ InputImageTile2dConstPtr

◆ InOutImageTile2dPtr

◆ InOutImageTile2dConstPtr

◆ OutputImageTile2dPtr

◆ OutputImageTile2dConstPtr

◆ ImageTile3dPtr

◆ ImageTile3dConstPtr

◆ InputImageTile3dPtr

◆ InputImageTile3dConstPtr

◆ InOutImageTile3dPtr

◆ InOutImageTile3dConstPtr

◆ OutputImageTile3dPtr

◆ OutputImageTile3dConstPtr

◆ DistributedImagePtr

◆ DistributedImageConstPtr

◆ DistributedImageWeakPtr

◆ DistributedImageConstWeakPtr

◆ ImagePtr

◆ ImageConstPtr

◆ ImageWeakPtr

◆ ImageConstWeakPtr

◆ DiskImagePtr

◆ DiskImageConstPtr

◆ MemoryImagePtr

◆ MemoryImageConstPtr

◆ UserImagePtr

◆ UserImageConstPtr

◆ CudaImagePtr

◆ CudaImageConstPtr

◆ PlanStorageColl1d

◆ PlanStorageConstColl1d

◆ PlanStorageColl2d

◆ PlanStorageConstColl2d

◆ PlanStorageColl3d

◆ PlanStorageConstColl3d

Enumeration Type Documentation

◆ eImageAccessorMessage

◆ eBorder2dMessage

◆ eBorder2dType

◆ eValuedBorder2dType

◆ eBorder3dMessage

◆ eBorder3dType

◆ eValuedBorder3dType

◆ eImageFragmentExtractorMessage

◆ eImageFragmentMessage

◆ eImageFragmentType

◆ eDataAccessMode

◆ eImageStripMessage

◆ eImageStripType

◆ eStripParsingDirection