ipsdk::image::ImageFactory Class Reference

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

#include <ImageFactory.h>

Inheritance diagram for ipsdk::image::ImageFactory:

Public Member Functions
void	setDefaultImageCreationFunction (const ImageCreationFunction &defaultImageCreationFunction)
	method allowing to define default image creation function More...
BoolResult	createDefaultImage (const BaseImageGeometry &geometry, ImagePtr &pOutputImage) const
	method allowing to create a default image from a geometry More...
BoolResult	createDiskImage (const BaseImageGeometry &geometry, DiskImagePtr &pOutputImage) const
	method allowing to create a disk image from an accessor More...
BoolResult	createDiskImage (const DiskImageAccessorPtr &pDiskImageAccessor, DiskImagePtr &pOutputImage) const
	method allowing to create a disk image from a geometry More...
BoolResult	createMemoryImage (const BaseImageGeometry &geometry, MemoryImagePtr &pOutputImage) const
	method allowing to create a memory image from a geometry More...
BoolResult	createCudaImage (const BaseImageGeometry &geometry, CudaImagePtr &pOutputImage) const
	method allowing to create a Cuda image from a geometry More...
BoolResult	createUserImage (const UserImageAccessorPtr &pUserImageAccessor, UserImagePtr &pOutputImage) const
	method allowing to create a user image from an accessor More...
BoolResult	createDistributedImage (const BaseImageGeometry &geometry, DistributedImagePtr &pOutputImage) const
	method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type More...
BoolResult	createDistributedImage (const DistributedImage &inputImage, DistributedImagePtr &pOutputImage) const
	method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type More...
BoolResult	createDistributedImage (const DistributedImage &inputImage, const eImageBufferType &imageBufferType, DistributedImagePtr &pOutputImage) const
	method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type More...

Static Public Member Functions
static ImageFactory &	getInstance ()
	retrieve unique instance of factory

Protected Member Functions
BoolResult	createInternalDefaultImage (const BaseImageGeometry &geometry, ImagePtr &pOutputImage) const
	method allowing to create a default image from a geometry More...
boost::filesystem::path	generateImageFileName (const boost::filesystem::path &filePath, const std::string &strExtension, const BaseImageGeometry &geometry) const
	generates the name of the image file with the format IPSDK_Image_YYYYMMDD_HHMMSS_eIBT_BufType_sizeXxSizeYxSizeZxSizeCxSizeT.strExtension The function also checks if the file already exists. In that case, the suffix "_X" is added before the extension, where X is the number of images already existing for example : IPSDK_Image_20230101_000000_eIBT_UInt8_100x100x1x1x1_2.strExtension
Constructors and destructor
	ImageFactory ()
	~ImageFactory ()

Protected Attributes
ImageCreationFunction	_defaultImageCreationFunction
	function allowing to create a new default image from a geometry

Detailed Description

Singleton object used to manage new images creation.

Author

E.Noirfalise

Date

2016/06/27

Copyright

2016 Reactiv'IP, all right reserved.

Member Function Documentation

setDefaultImageCreationFunction()

void ipsdk::image::ImageFactory::setDefaultImageCreationFunction

(

const ImageCreationFunction &

defaultImageCreationFunction

)

method allowing to define default image creation function

Note

by default create MemoryImage objects

createDefaultImage()

BoolResult ipsdk::image::ImageFactory::createDefaultImage	(	const BaseImageGeometry &	geometry,
		ImagePtr &	pOutputImage
	)		const

method allowing to create a default image from a geometry

Returns

false in case of failure

createDiskImage() [1/2]

BoolResult ipsdk::image::ImageFactory::createDiskImage	(	const BaseImageGeometry &	geometry,
		DiskImagePtr &	pOutputImage
	)		const

method allowing to create a disk image from an accessor

Returns

false in case of failure

createDiskImage() [2/2]

BoolResult ipsdk::image::ImageFactory::createDiskImage	(	const DiskImageAccessorPtr &	pDiskImageAccessor,
		DiskImagePtr &	pOutputImage
	)		const

method allowing to create a disk image from a geometry

Returns

false in case of failure

createDistributedImage() [1/3]

BoolResult ipsdk::image::ImageFactory::createDistributedImage	(	const BaseImageGeometry &	geometry,
		DistributedImagePtr &	pOutputImage
	)		const

method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type

Returns

false in case of failure

createDistributedImage() [2/3]

BoolResult ipsdk::image::ImageFactory::createDistributedImage	(	const DistributedImage &	inputImage,
		DistributedImagePtr &	pOutputImage
	)		const

method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type

Returns

false in case of failure

createDistributedImage() [3/3]

BoolResult ipsdk::image::ImageFactory::createDistributedImage	(	const DistributedImage &	inputImage,
		const eImageBufferType &	imageBufferType,
		DistributedImagePtr &	pOutputImage
	)		const

method allowing to create a distributed image from a geometry, from a other distributed image or from a other distributed image and a buffer type

Returns

false in case of failure

createMemoryImage()

BoolResult ipsdk::image::ImageFactory::createMemoryImage	(	const BaseImageGeometry &	geometry,
		MemoryImagePtr &	pOutputImage
	)		const

method allowing to create a memory image from a geometry

Returns

false in case of failure

createCudaImage()

BoolResult ipsdk::image::ImageFactory::createCudaImage	(	const BaseImageGeometry &	geometry,
		CudaImagePtr &	pOutputImage
	)		const

method allowing to create a Cuda image from a geometry

Returns

false in case of failure

createUserImage()

BoolResult ipsdk::image::ImageFactory::createUserImage	(	const UserImageAccessorPtr &	pUserImageAccessor,
		UserImagePtr &	pOutputImage
	)		const

method allowing to create a user image from an accessor

Returns

false in case of failure

createInternalDefaultImage()

BoolResult ipsdk::image::ImageFactory::createInternalDefaultImage ( const BaseImageGeometry &  geometry, ImagePtr &  pOutputImage  ) const

protected

method allowing to create a default image from a geometry

Returns

false in case of failure

---

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