ipsdk::image::file Namespace Reference

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

Classes
class	AutoDiskImageAccessor
	Class for disk image automatically allocated by IPSDK. More...
struct	CalibrationData
struct	HeaderData
	shared pointer to file stream More...
class	Im6ImageFile
	Class for im6 disk image access. More...
class	IPSDKImageFileException
	Exception class for library IPSDKImageFile. More...
class	MultiFileDiskImageAccessor
	Class for disk image initialized with a plan storage collection. More...
class	RawImageFile
	Class for raw disk image access. More...
class	TiffImageFile
	Class allowing to access tiff disk images. More...

Enumerations
enum	eIm6ImageFileMessage {   eCreateFileFailed, eCreateFileFailedWin32, eDistributedImageCreationFailed, eFailedToWriteFileHeader,   eGeometryGreaterThanFileSize, eInvalidPlanIdx, eLoadIm6Error, eOpenFileFailed,   eReadFailed, eReserveSpaceFailed, eReserveSpaceFailedWin32, eSaveIm6Error,   eSeekFailed, eWriteFailed, eWriteFailedWin32 }
	Enumerate describing messages. More...
enum	eIPSDKImageFileMessage
	Enumerate describing messages. More...
enum	eRawImageFileMessage {   eCreateFileFailed, eCreateFileFailedWin32, eDistributedImageCreationFailed, eFailedToWriteFileHeader,   eGeometryGreaterThanFileSize, eInvalidPlanIdx, eLoadRawError, eOpenFileFailed,   eReadFailed, eReserveSpaceFailed, eReserveSpaceFailedWin32, eSaveRawError,   eSeekFailed, eWriteFailed, eWriteFailedWin32 }
	Enumerate describing messages. More...
enum	eTiffImageFileMessage {   eBufferTypeMismatch, eCloseFileException, eColorGeometryTypeMismatch, eCreateFileException,   eCreateFileFailed, eDistributedImageCreationFailed, eImageCreationFailed, eInvalidCalibration,   eInvalidImageBufferType, eInvalidNbPages, eInvalidPlanSize, eLoadTiffError,   eLoadZStepsTxtFileErrorNAN, eLoadZStepsXmlFileError, eOpenFileException, eOpenFileFailed,   ePlanColorTypeMismatch, ePlanSizeMismatch, eSaveTiffError, eSizeCMismatch,   eSizeXMismatch, eSizeYMismatch, eSizeZMismatch, eTemporalGeometryShouldBeSingle,   eTiffFlushFailed, eTiffGetTagFailed, eTiffInitStripFailed, eTiffMsgFailed,   eTiffNoInterleavedRgb, eTiffReadRowFailed, eTiffReadStripFailed, eTiffSetDirectoryFailed,   eTiffSetTagFailed, eTiffWriteDirectoryFailed, eTiffWriteRowFailed, eTiffWriteStripFailed,   eUnSupportedBufferType, eUnSupportedCompressionMode, eUnSupportedOrientation, eUnSupportedPackedColorImage,   eUnSupportedPackedWriteImage, eUnSupportedPhotometric, eUnSupportedPlanarConfig, eUnSupportedSubFileType,   eVolumeGeometryTypeMismatch, eZStepsSizeNotMatchingWithNbZPlans }
	Enumerate describing messages. More...
enum	eTiffDirectoryMode { eTDM_Volume, eTDM_Temporal }
	Flag used to interpret tiff directories in term of image geometry. More...
enum	eTiffBufferMode { eTBM_Default, eTBM_Binary, eTBM_Label }
	Flag used to interpret tiff data type. More...
enum	eTiffCompression { eTC_None, eTC_Lzw, eTC_Zip }
	Flag used to select a tiff compression mode. More...
enum	eImageFileUtilsMessage { eMoreThanOneInstanceOfIndexPattern, eInvalidFilePatternWithMixOfIndexAndNoIndex }

Functions
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedIm6ImageFile (const boost::filesystem::path &im6FilePath, const bool bSharedFileAccess=false)
	function allowing to load a im6 image file into a distributed image More...
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedIm6ImageFile (const boost::filesystem::path &im6FilePath, const DistributedImage &refImage, const bool bSharedFileAccess=false)
	function allowing to load a im6 image file into a distributed image More...
IPSDKIMAGEFILE_API const std::string &	getIPSDKImageFileLoggerName ()
	Recovery of logger name associated to library.
IPSDKIMAGEFILE_API log4cplus::Logger &	getIPSDKImageFileLogger ()
	Recovery of logger associated to library.
IPSDKIMAGEFILE_API const LogMessageManager &	getIPSDKImageFileLogMessageManager ()
	Recovery of message manager associated to library.
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedRawImageFile (const boost::filesystem::path &rawFilePath, const BaseImageGeometry &imageGeometry, const ipUInt64 dataStartOffset=0, const bool bSharedFileAccess=false)
	function allowing to load a raw image file into a distributed image More...
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedRawImageFile (const boost::filesystem::path &rawFilePath, const DistributedImage &refImage, const eImageBufferType &imageBufferType, const ipUInt64 dataStartOffset=0, const bool bSharedFileAccess=false)
	function allowing to load a raw image file into a distributed image with respect to an existing distributed image geometry More...
IPSDKIMAGEFILE_API DiskImagePtr	openRawImageFile (const boost::filesystem::path &rawFilePath, const BaseImageGeometry &imageGeometry, const ipUInt64 dataStartOffset=0)
	function allowing to open a raw file as a disk image More...
IPSDKIMAGEFILE_API void	saveRawImageFile (const boost::filesystem::path &rawFilePath, const ImageConstPtr &pImage, const std::string &headerData=std::string())
	function allowing to save a raw image file More...
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedTiffImageFile (const boost::filesystem::path &tiffFilePath, const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default, const bool bSharedFileAccess=false)
	function allowing to load a tiff image file into a distributed image More...
IPSDKIMAGEFILE_API DistributedImagePtr	loadDistributedTiffImageFile (const boost::filesystem::path &tiffFilePath, const DistributedImage &refImage, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default, const bool bSharedFileAccess=false)
	function allowing to load a tiff image file into a distributed image with respect to an existing distributed image geometry More...
IPSDKIMAGEFILE_API ImagePtr	loadTiffImageFiles (const boost::filesystem::path &dirPath, const std::string &pattern="*.tif|*.tiff", const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to load an image from tiff image files contained in a given directory More...
IPSDKIMAGEFILE_API ImagePtr	loadCustomZStackImageFiles (const boost::filesystem::path &dirPath, const boost::filesystem::path &zStepsFilePath, const ipUInt64 nbZPlansInOutputImg, const imaproc::attr::eInterpolationPolicy &interpolationPolicy, const std::string &pattern="*.tif|*.tiff", const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to load a 3d image scattered over tiff files contained in a given directory, and to resample it along z-axis More...
IPSDKIMAGEFILE_API DiskImagePtr	openTiffImageFile (const boost::filesystem::path &tiffFilePath, const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to open a tiff file as a disk image More...
IPSDKIMAGEFILE_API ImagePtr	openTiffImageFiles (const boost::filesystem::path &dirPath, const std::string &pattern="*.tif|*.tiff", const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to open a disk image from tiff image files contained in a given directory More...
IPSDKIMAGEFILE_API void	saveTiffImageFile (const boost::filesystem::path &tiffFilePath, const ImageConstPtr &pImage, const eTiffCompression &tiffCompression=eTiffCompression::eTC_Lzw)
	function allowing to save a tiff image file More...
IPSDKIMAGEFILE_API bool	imageGeometryMatchesLicenseFeatures (const ipsdk::image::BaseImageGeometry &geometry)
	returns true if image is 2D ior if the image is 3D and the license has 3D feature enabled
IPSDKIMAGEFILE_API bool	detectDongle ()
	returns false if the license file is a dongle license and if the dongle is unplugged i.e. the license is not valid
IPSDKIMAGEFILE_API bool	testFilePatternMatching (const std::string &pattern, const std::string &parsedString, ipUInt64 &index)
	function checking if string to parse matches the pattern specified by the user Here are the accepted key characters/key words: More...
IPSDKIMAGEFILE_API ImagePtr	loadIm6ImageFile (const boost::filesystem::path &im6FilePath)
	function allowing to load a im6 image file More...
IPSDKIMAGEFILE_API void	loadIm6ImageFile (const boost::filesystem::path &im6FilePath, const ImagePtr &pOutImg)
	function allowing to load a im6 image file More...
IPSDKIMAGEFILE_API ImagePtr	loadRawImageFile (const boost::filesystem::path &rawFilePath, const BaseImageGeometry &imageGeometry, const ipUInt64 dataStartOffset=0)
	function allowing to load a raw image file More...
IPSDKIMAGEFILE_API void	loadRawImageFile (const boost::filesystem::path &rawFilePath, const BaseImageGeometry &imageGeometry, const ImagePtr &pOutImg, const ipUInt64 dataStartOffset=0)
	function allowing to load a raw image file More...
IPSDKIMAGEFILE_API ImagePtr	loadTiffImageFile (const boost::filesystem::path &tiffFilePath, const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to load a tiff image file More...
IPSDKIMAGEFILE_API void	loadTiffImageFile (const boost::filesystem::path &tiffFilePath, ImagePtr &pOutImg, const eTiffDirectoryMode &tiffDirectoryMode=eTiffDirectoryMode::eTDM_Volume, const eTiffBufferMode &tiffBufferMode=eTiffBufferMode::eTBM_Default)
	function allowing to load a tiff image file More...
IPSDKIMAGEFILE_API ImagePtr	loadTiffImageFile (const boost::filesystem::path &tiffFilePath, const eTiffBufferMode &tiffBufferMode)
	function allowing to load a tiff image file More...
IPSDKIMAGEFILE_API void	loadTiffImageFile (const boost::filesystem::path &tiffFilePath, const eTiffBufferMode &tiffBufferMode, ImagePtr &pOutImg)
	function allowing to load a tiff image file More...

Detailed Description

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

Enumeration Type Documentation

eIm6ImageFileMessage

enum ipsdk::image::file::eIm6ImageFileMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eCreateFileFailed	Failed to create im6 image file s. Failed to create tiff image file s s. Failed to create raw image file s.
eCreateFileFailedWin32	Failed to create im6 image file s s. Failed to create raw image file s s.
eDistributedImageCreationFailed	Failed to create distributed image s.
eFailedToWriteFileHeader	Failed to write file header for file s s.
eGeometryGreaterThanFileSize	Input geometry with total size lld and starting offset lld is greater than global file size lld for im6 image file s. Input geometry with total size lld and starting offset lld is greater than global file size lld for raw image file s.
eInvalidPlanIdx	Invalid plan component indexes z=d c=d t=d.
eLoadIm6Error	Error while loading im6 image file s s.
eOpenFileFailed	Failed to open im6 image file s. Failed to open tiff image file s s. Failed to open raw image file s.
eReadFailed	Failed to read im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld. Failed to read raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eReserveSpaceFailed	Failed to reserve lld bytes for im6 image file s. Failed to reserve lld bytes for raw image file s.
eReserveSpaceFailedWin32	Failed to reserve lld bytes for im6 image file s s. Failed to reserve lld bytes for raw image file s s.
eSaveIm6Error	Error while saving im6 image file s s.
eSeekFailed	Failed to seek position into im6 image file s for z=d, c=d, t=d and pixelStartOffset=lld. Failed to seek position into raw image file s for z=d, c=d, t=d and pixelStartOffset=lld.
eWriteFailed	Failed to write im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld. Failed to write raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eWriteFailedWin32	Failed to write im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld s. Failed to write raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld s.

eIPSDKImageFileMessage

enum ipsdk::image::file::eIPSDKImageFileMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

eRawImageFileMessage

enum ipsdk::image::file::eRawImageFileMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eCreateFileFailed	Failed to create im6 image file s. Failed to create tiff image file s s. Failed to create raw image file s.
eCreateFileFailedWin32	Failed to create im6 image file s s. Failed to create raw image file s s.
eDistributedImageCreationFailed	Failed to create distributed image s.
eFailedToWriteFileHeader	Failed to write file header for file s s.
eGeometryGreaterThanFileSize	Input geometry with total size lld and starting offset lld is greater than global file size lld for im6 image file s. Input geometry with total size lld and starting offset lld is greater than global file size lld for raw image file s.
eInvalidPlanIdx	Invalid plan component indexes z=d c=d t=d.
eLoadRawError	Error while loading raw image file s s.
eOpenFileFailed	Failed to open im6 image file s. Failed to open tiff image file s s. Failed to open raw image file s.
eReadFailed	Failed to read im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld. Failed to read raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eReserveSpaceFailed	Failed to reserve lld bytes for im6 image file s. Failed to reserve lld bytes for raw image file s.
eReserveSpaceFailedWin32	Failed to reserve lld bytes for im6 image file s s. Failed to reserve lld bytes for raw image file s s.
eSaveRawError	Error while saving raw image file s s.
eSeekFailed	Failed to seek position into im6 image file s for z=d, c=d, t=d and pixelStartOffset=lld. Failed to seek position into raw image file s for z=d, c=d, t=d and pixelStartOffset=lld.
eWriteFailed	Failed to write im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld. Failed to write raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld.
eWriteFailedWin32	Failed to write im6 image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld s. Failed to write raw image file s for z=d, c=d, t=d, pixelStartOffset=lld and nbPixels=lld s.

eTiffImageFileMessage

enum ipsdk::image::file::eTiffImageFileMessage

Enumerate describing messages.

Note

This enumerate is associated to a message map

See also

IPSDK_Message_Map

Enumerator
eBufferTypeMismatch	Buffer type mismatch between input image read from "s" (s) and input image read from "s" (s)
eCloseFileException	An exception has been thrown while trying to close tiff file s.
eColorGeometryTypeMismatch	Color geometry type mismatch between input image read from "s" (s) and input image read from "s" (s)
eCreateFileException	An exception has been thrown while creating file s s.
eCreateFileFailed	Failed to create im6 image file s. Failed to create tiff image file s s. Failed to create raw image file s.
eDistributedImageCreationFailed	Failed to create distributed image s.
eImageCreationFailed	Failed to create output image s.
eInvalidCalibration	Resolution values x=f and y=f are not valid for image calibration into image file s.
eInvalidImageBufferType	Invalid image buffer type enum value d.
eInvalidNbPages	Un supported number of image image plans d, greater than allowed tiff file number of pages d for file s.
eInvalidPlanSize	Un supported plan size [sizeX=d, sizeY=d], greater than allowed tiff file components plan size d for file s.
eLoadTiffError	Error while loading tiff image file s s.
eLoadZStepsTxtFileErrorNAN	Error while loading z-steps txt file "s": field at line d is not a positive numerical value.
eLoadZStepsXmlFileError	Error while loading z-steps file "s": s.
eOpenFileException	An exception has been thrown while opening file s s.
eOpenFileFailed	Failed to open im6 image file s. Failed to open tiff image file s s. Failed to open raw image file s.
ePlanColorTypeMismatch	Plan color type mismatch among tiff directories, found s whereas reference is s for file s.
ePlanSizeMismatch	Plan size mismatch among tiff directories, found x=d y=d whereas reference is x=d y=d for file s.
eSaveTiffError	Error while saving tiff image file s s.
eSizeCMismatch	SizeC mismatch between input image read from "s" (d) and input image read from "s" (d)
eSizeXMismatch	SizeX mismatch between input image read from "s" (d) and input image read from "s" (d)
eSizeYMismatch	SizeY mismatch between input image read from "s" (d) and input image read from "s" (d)
eSizeZMismatch	SizeZ mismatch between input image read from "s" (d) and input image read from "s" (d)
eTemporalGeometryShouldBeSingle	Temporal geometry should be single.
eTiffFlushFailed	Error while flushing tiff data for file s s.
eTiffGetTagFailed	Error while getting tiff tag s for file s s.
eTiffInitStripFailed	Failed to initialize strip data of directory d for file s s.
eTiffMsgFailed	Error while decoding tiff error message [s].
eTiffNoInterleavedRgb	Only interleaved Rgb tiff can be proceeded using rgb functions, while proceeding file s.
eTiffReadRowFailed	Failed to read data of row d for directory z=d, c=d, t=d of file s s)
eTiffReadStripFailed	Failed to read data of strip d for directory z=d, c=d, t=d of file s s.
eTiffSetDirectoryFailed	Error while setting directory d for file s s.
eTiffSetTagFailed	Error while setting tiff tag s for file s s.
eTiffWriteDirectoryFailed	Error while writing directory s for file s s.
eTiffWriteRowFailed	Failed to write data of row d for directory z=d, c=d, t=d of file s s.
eTiffWriteStripFailed	Failed to write data of strip d for directory z=d, c=d, t=d of file s s.
eUnSupportedBufferType	Un supported image buffer type with bitsPerSamples=d, sampleFormat=d and image buffer mode s for file s.
eUnSupportedCompressionMode	Un supported tiff compression mode s for file s.
eUnSupportedOrientation	Un supported plan orientation value d for file s, image geometry may not be correctly read.
eUnSupportedPackedColorImage	Un supported packed color image (ie. one bit per pixel binary image with color components) for file s.
eUnSupportedPackedWriteImage	Un supported packed image with write access for file s.
eUnSupportedPhotometric	Un supported photometric interpretation value d with d samples per pixels for file s.
eUnSupportedPlanarConfig	Un supported planar configuration value d for file s.
eUnSupportedSubFileType	Un supported sub file type value d for file s.
eVolumeGeometryTypeMismatch	Volume geometry type mismatch between input image read from "s" (s) and input image read from "s" (s)
eZStepsSizeNotMatchingWithNbZPlans	Number of z-steps (d) does not match with number of z-plans minus one (d-1)

eTiffDirectoryMode

enum ipsdk::image::file::eTiffDirectoryMode

Flag used to interpret tiff directories in term of image geometry.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eTDM_Volume	Tiff directories will be interpreted as a volume collection (3d case)
eTDM_Temporal	Tiff directories will be interpreted as a temporal collection (sequence case)

eTiffBufferMode

enum ipsdk::image::file::eTiffBufferMode

Flag used to interpret tiff data type.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eTBM_Default	Image data type will be simply retrieved into tiff image file.
eTBM_Binary	Image data type will be forced to binary.
eTBM_Label	Image data type will be forced to label.

eTiffCompression

enum ipsdk::image::file::eTiffCompression

Flag used to select a tiff compression mode.

Note

This object is associated to a strong enumerate definition

See also

IPSDK_Enum

Enumerator
eTC_None	No compression will be used.
eTC_Lzw	LZW (Lempel-Ziv and Welch) compression algorithm will be used.
eTC_Zip	Zip (deflate/inflate) compression algorithm will be used.

eImageFileUtilsMessage

enum ipsdk::image::file::eImageFileUtilsMessage

Enumerator
eMoreThanOneInstanceOfIndexPattern	More than one instance of keyword "<INDEX>" in pattern "s".
eInvalidFilePatternWithMixOfIndexAndNoIndex	Invalid pattern string (s), mixing patterns with and without keyword "<INDEX>".

Function Documentation

loadDistributedIm6ImageFile() [1/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedIm6ImageFile	(	const boost::filesystem::path &	im6FilePath,
		const bool	bSharedFileAccess = false
	)

function allowing to load a im6 image file into a distributed image

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadDistributedIm6ImageFile() [2/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedIm6ImageFile	(	const boost::filesystem::path &	im6FilePath,
		const DistributedImage &	refImage,
		const bool	bSharedFileAccess = false
	)

function allowing to load a im6 image file into a distributed image

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadDistributedRawImageFile() [1/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedRawImageFile	(	const boost::filesystem::path &	rawFilePath,
		const BaseImageGeometry &	imageGeometry,
		const ipUInt64	dataStartOffset = 0,
		const bool	bSharedFileAccess = false
	)

function allowing to load a raw image file into a distributed image

Note

input image geometry must be compatible with image file

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadDistributedRawImageFile() [2/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedRawImageFile	(	const boost::filesystem::path &	rawFilePath,
		const DistributedImage &	refImage,
		const eImageBufferType &	imageBufferType,
		const ipUInt64	dataStartOffset = 0,
		const bool	bSharedFileAccess = false
	)

function allowing to load a raw image file into a distributed image with respect to an existing distributed image geometry

Note

input image geometry and buffer type must be compatible with image file

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadDistributedTiffImageFile() [1/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedTiffImageFile	(	const boost::filesystem::path &	tiffFilePath,
		const eTiffDirectoryMode &	tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
		const eTiffBufferMode &	tiffBufferMode = eTiffBufferMode::eTBM_Default,
		const bool	bSharedFileAccess = false
	)

function allowing to load a tiff image file into a distributed image

Note

tiffDirectoryMode parameter will only be interpreted in case of external tiff images, IPSDK tiff images provided embedded image geometry

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadDistributedTiffImageFile() [2/2]

IPSDKIMAGEFILE_API DistributedImagePtr ipsdk::image::file::loadDistributedTiffImageFile	(	const boost::filesystem::path &	tiffFilePath,
		const DistributedImage &	refImage,
		const eTiffBufferMode &	tiffBufferMode = eTiffBufferMode::eTBM_Default,
		const bool	bSharedFileAccess = false
	)

function allowing to load a tiff image file into a distributed image with respect to an existing distributed image geometry

Exceptions

ipsdk::image::file::IPSDKImageFileException

on failure

loadCustomZStackImageFiles()

IPSDKIMAGEFILE_API ImagePtr ipsdk::image::file::loadCustomZStackImageFiles	(	const boost::filesystem::path &	dirPath,
		const boost::filesystem::path &	zStepsFilePath,
		const ipUInt64	nbZPlansInOutputImg,
		const imaproc::attr::eInterpolationPolicy &	interpolationPolicy,
		const std::string &	pattern = "*.tif|*.tiff",
		const eTiffBufferMode &	tiffBufferMode = eTiffBufferMode::eTBM_Default
	)

function allowing to load a 3d image scattered over tiff files contained in a given directory, and to resample it along z-axis

Note

implicit retained mode to load tiff files is eTiffDirectoryMode::eTDM_Volume

Exceptions

ipsdk::image::file::IPSDKImageFileException	on failure
ipsdk::image::file::IPSDKImageFileException	if pattern string is invalid (see detailed description of the function)

Returns

Image loaded from files matching pattern; return an uninitialized pointer if no file has been found

Parameters

dirPath	path of the directory containing the files from which the image is built
zStepsFilePath	path of the file (in XML format or text format) describing the z-steps between the consecutive z slices of the 3d image
nbZPlansInOutputImg	number of z-plans in the resulting 3d image
pattern	file pattern used to filter the set of files found in directory. See the detailed description below

This function loads an image from the TIFF files that are contained in the directory 'dirPath' and that match the pattern(s) specified by the user. Once the image is loaded, it is resampled along the z-axis using the collection of z-steps defined in the .txt or .xml file located at 'zStepsFilePath'. Resampling process is done using an interpolation defined by the 'interpolationPolicy' parameter.

See also

loadTiffImageFiles for details about how to use the pattern matching

openTiffImageFiles()

IPSDKIMAGEFILE_API ImagePtr ipsdk::image::file::openTiffImageFiles	(	const boost::filesystem::path &	dirPath,
		const std::string &	pattern = "*.tif|*.tiff",
		const eTiffDirectoryMode &	tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
		const eTiffBufferMode &	tiffBufferMode = eTiffBufferMode::eTBM_Default
	)

function allowing to open a disk image from tiff image files contained in a given directory

See also

loadTiffImageFiles for details

testFilePatternMatching()

IPSDKIMAGEFILE_API bool ipsdk::image::file::testFilePatternMatching	(	const std::string &	pattern,
		const std::string &	parsedString,
		ipUInt64 &	index
	)

function checking if string to parse matches the pattern specified by the user Here are the accepted key characters/key words:

• '*': stands for "any set of characters, of any size (0 or greater)"
• '<INDEX>: wait for unsigned integer, that will be assigned to index argument example of pattern matching results:
• matching "my_image_003.tif" with pattern "image" will return false
• matching "my_image_003.tif" with pattern "*image*" will return true
• matching "my_image_003.tif" with pattern "m*image*$INDEX$.*" will return true, and value 3 will be assigned to index