IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
TiffImageFileUtils.h
Go to the documentation of this file.
1 // TiffImageFileUtils.h:
3 // ---------------------
4 //
14 
15 #ifndef __IPSDKIMAGEFILE_TIFFIMAGEFILEUTILS_H__
16 #define __IPSDKIMAGEFILE_TIFFIMAGEFILEUTILS_H__
17 
21 #include <IPSDKIPL/IPSDKIPLAttributes/Attribute/Enumerate/InInterpolationPolicy.h>
22 
23 namespace ipsdk {
24 namespace image {
25 
26 class DistributedImage;
27 
28 namespace file {
29 
32 
41 loadTiffImageFile(const boost::filesystem::path& tiffFilePath,
42  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
43  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
45 loadTiffImageFile(const boost::filesystem::path& tiffFilePath,
46  ImagePtr& pOutImg,
47  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
48  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
50 
58 loadTiffImageFile(const boost::filesystem::path& tiffFilePath,
59  const eTiffBufferMode& tiffBufferMode);
61 loadTiffImageFile(const boost::filesystem::path& tiffFilePath,
62  const eTiffBufferMode& tiffBufferMode,
63  ImagePtr& pOutImg);
65 
71 loadDistributedTiffImageFile(const boost::filesystem::path& tiffFilePath,
72  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
73  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default,
74  const bool bSharedFileAccess = false);
75 
80 loadDistributedTiffImageFile(const boost::filesystem::path& tiffFilePath,
81  const DistributedImage& refImage,
82  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default,
83  const bool bSharedFileAccess = false);
84 
120 loadTiffImageFiles(const boost::filesystem::path& dirPath,
121  const std::string& pattern="*.tif|*.tiff",
122  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
123  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
124 
146 loadCustomZStackImageFiles(const boost::filesystem::path& dirPath,
147  const boost::filesystem::path& zStepsFilePath,
148  const ipUInt64 nbZPlansInOutputImg,
149  const imaproc::attr::eInterpolationPolicy& interpolationPolicy,
150  const std::string& pattern = "*.tif|*.tiff",
151  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
152 
157 openTiffImageFile(const boost::filesystem::path& tiffFilePath,
158  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
159  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
160 
164 openTiffImageFiles(const boost::filesystem::path& dirPath,
165  const std::string& pattern="*.tif|*.tiff",
166  const eTiffDirectoryMode& tiffDirectoryMode = eTiffDirectoryMode::eTDM_Volume,
167  const eTiffBufferMode& tiffBufferMode = eTiffBufferMode::eTBM_Default);
168 
173 saveTiffImageFile(const boost::filesystem::path& tiffFilePath,
174  const ImageConstPtr& pImage,
175  const eTiffCompression& tiffCompression = eTiffCompression::eTC_Lzw);
176 
179 
180 } // end of namespace file
181 } // end of namespace image
182 } // end of namespace ipsdk
183 
184 #endif // __IPSDKIMAGEFILE_TIFFIMAGEFILEUTILS_H__
Tiff directories will be interpreted as a volume collection (3d case)
Definition: TiffImageFileTypes.h:33
eTiffBufferMode
Flag used to interpret tiff data type.
Definition: TiffImageFileTypes.h:43
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22
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
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 ...
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
uint64_t ipUInt64
Base types definition.
Definition: BaseTypes.h:55
#define IPSDKIMAGEFILE_API
Import/Export macro for library IPSDKImageFile.
Definition: IPSDKImageFileExports.h:27
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
boost::shared_ptr< BaseImage > ImagePtr
Definition: ImageTypes.h:139
Definition of import/export macro for library.
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
Image data type will be simply retrieved into tiff image file.
Definition: TiffImageFileTypes.h:45
eTiffDirectoryMode
Flag used to interpret tiff directories in term of image geometry.
Definition: TiffImageFileTypes.h:31
boost::shared_ptr< const BaseImage > ImageConstPtr
Definition: ImageTypes.h:140
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 ...
boost::shared_ptr< DistributedImage > DistributedImagePtr
Definition: DistributedImageTypes.h:38
boost::shared_ptr< DiskImage > DiskImagePtr
Definition: ImageTypes.h:151
LZW (Lempel-Ziv and Welch) compression algorithm will be used.
Definition: TiffImageFileTypes.h:61
eTiffCompression
Flag used to select a tiff compression mode.
Definition: TiffImageFileTypes.h:57
Predefined types for TiffImageFile management.
Predefined type for image management.
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...