IPSDKCore/html/a12545_source.html

 // ImageUtils.h:
 // -------------
 //

 #ifndef __IPSDKIMAGE_IMAGEUTILS_H__
 #define __IPSDKIMAGE_IMAGEUTILS_H__

 #include <IPSDKImage/IPSDKImageExports.h>
 #include <IPSDKImage/Image/ImageTypes.h>
 #include <IPSDKImage/Geometry/ImageGeometryTypes.h>
 #include <IPSDKUtil/Tools/ProcessingResult.h>
 #include <IPSDKSerialization/Engine/SerializationEnumHdrMacro.h>

 namespace ipsdk {
 namespace image {


 IPSDKIMAGE_API eDataType
 toDataType(const eImageBufferType& imageBufferType);

 IPSDKIMAGE_API ipUInt32
 getImageBufferBaseSize(const eImageBufferType& imageBufferType);

 IPSDKIMAGE_API std::string
 getFormatedName(const DataIdentifier& imageIdentifier,
                 const eFormatedType& formatedType = eFormatedType::eFT_Full);

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

 IPSDKIMAGE_API ipReal64
 getMinValue(const eImageBufferType& imageBufferType);

 IPSDKIMAGE_API ipReal64
 getMaxValue(const eImageBufferType& imageBufferType);

 IPSDKIMAGE_API BoolResult
 canBeReInterpreted(const BaseImage& originalImage,
                    const BaseImageGeometry& targetGeometry);

 IPSDKIMAGE_API BoolResult
 createImage(const BaseImage& originalImage,
             ImagePtr& pOutImg);

 IPSDKIMAGE_API ImagePtr
 createImage(const BaseImage& originalImage);

 IPSDKIMAGE_API BoolResult
 createImage(const BaseImage& originalImage,
             const eImageBufferType& outImageBufferType,
             ImagePtr& pOutImg);

 IPSDKIMAGE_API ImagePtr
 createImage(const BaseImage& originalImage,
             const eImageBufferType& outImageBufferType);

 // / \ingroup IPSDKConcepts_BasicData_ImageManip_BasicImageManip_Grp
 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);

 // / \ingroup IPSDKConcepts_BasicData_ImageManip_BasicImageManip_Grp
 template <typename T>
 IPSDKIMAGE_API T* extractBufferFromImage(BaseImage& inImg, const ipUInt64 sizeY, const ipUInt64 z = 0, const ipUInt64 c = 0, const ipUInt64 t = 0);


 } // end of namespace image

 IPSDK_DECLARE_SERIAL_ENUM(IPSDKImage, image::eImageBufferType)

 IPSDK_DECLARE_SERIAL_ENUM(IPSDKImage, image::eImageAccessMode)

 } // end of namespace ipsdk

 #endif // __IPSDKIMAGE_IMAGEUTILS_H__
ipsdk::image::getMaxValue
IPSDKIMAGE_API ipReal64 getMaxValue(const eImageBufferType &imageBufferType)
retrieve maximum value for a given image buffer type

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

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

ipsdk
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22

ipsdk::IPSDK_DECLARE_SERIAL_ENUM
IPSDK_DECLARE_SERIAL_ENUM(IPSDKBaseData, eDiscreteOrientation2d)
serialization operators for eDiscreteOrientation2d enumerate

ipsdk::ipUInt64
uint64_t ipUInt64
Base types definition.
Definition: BaseTypes.h:55

ipsdk::image::ImagePtr
boost::shared_ptr< BaseImage > ImagePtr
Definition: ImageTypes.h:139

ipsdk::ipReal64
double ipReal64
Base types definition.
Definition: BaseTypes.h:57

ipsdk::image::eFormatedType
eFormatedType
Type for generation of formated image name.
Definition: ImageTypes.h:124

ipsdk::image::extractBufferFromConstImage
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

SerializationEnumHdrMacro.h
Macro allowing to declare serialization for a given enumerate.

ipsdk::image::extractBufferFromImage
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

IPSDKImageExports.h
Definition of import/export macro for library.

ipsdk::eDataType
eDataType
Enumerate describing a base type.
Definition: BaseTypes.h:77

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

ImageGeometryTypes.h
Predefined types for image geometry management.

IPSDKIMAGE_API
#define IPSDKIMAGE_API
Import/Export macro for library IPSDKImage.
Definition: IPSDKImageExports.h:27

ipsdk::image::eFT_Full
Full image formated name (default : Name {Guid})
Definition: ImageTypes.h:126

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

ipsdk::BoolResult
ProcessingResult< bool > BoolResult
typedef for boolean results associated to a string description
Definition: ProcessingResultTypes.h:29

ipsdk::image::canBeReInterpreted
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...

ImageTypes.h
Predefined type for image management.

ipsdk::image::eImageAccessMode
eImageAccessMode
Image access mode.
Definition: ImageTypes.h:110

ipsdk::image::eImageBufferType
eImageBufferType
types associated to image buffers
Definition: ImageTypes.h:78

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

ipsdk::ipUInt32
uint32_t ipUInt32
Base types definition.
Definition: BaseTypes.h:53