IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
Namespaces | Classes | Typedefs | Enumerations | Functions
ipsdk Namespace Reference

Main namespace for IPSDK library. More...

Namespaces

 bench
 Namespace agregating IPSDK benchmark routines and classes.
 
 core
 Namespace agregating IPSDK core execution routines and classes.
 
 geom
 Namespace aggregating geometrical routines and classes.
 
 hard
 Namespace agregating IPSDK hardware and system management execution routines and classes.
 
 hid
 Namespace aggregating.
 
 image
 Namespace agregating IPSDK image management routines and classes.
 
 imaproc
 Namespace agregating IPSDK base routines and classes for image algorithm processing.
 
 lic
 Namespace agregating IPSDK license management routines and classes.
 
 math
 Namespace agregating IPSDK mathematical routines and classes.
 
 processor
 Namespace agregating IPSDK base routines and classes for algorithm processing.
 
 python
 Namespace aggregating IPSDK to python base wrappers.
 
 simd
 Namespace agregating IPSDK SIMD routines and classes.
 
 tcpip
 Namespace agregating IPSDK TCP/IP network communication routines and classes.
 
 unittest
 Namespace agregating IPSDK unit test routines and classes.
 

Classes

class  ArchiveSectionManager
 Class providing section management for archive serialization. More...
 
struct  Avx512MaskType
 
struct  Avx512Type
 structure used to retrieve AVX512 type associated to a base type More...
 
struct  AvxMaskType
 structure used to retrieve AVX mask type associated to a base type More...
 
struct  AvxType
 structure used to retrieve AVX type associated to a base type More...
 
class  BaseArchive
 Base class for serialization archives. More...
 
class  BaseBlockBuffer
 Base class for mono block buffers. More...
 
class  BaseBuffer
 Base class for buffer encapsulation. More...
 
class  BaseDataItem
 Base class for data items. More...
 
class  BaseDataItemEnumLeaf
 Base class for data item leafs associated to enumerate value. More...
 
class  BaseDataItemLeaf
 Base class for data item leafs. More...
 
class  BaseDataItemLeafColl
 Base class for collection of data item leafs. More...
 
class  BaseDataItemNode
 Base class for data item nodes. More...
 
class  BaseDataItemNodeColl
 Base class used to store data item nodes collection. More...
 
class  BaseDynamicObject
 Base class for dynamic objects. More...
 
class  BaseException
 Base exception class for IPSDK library. More...
 
class  BaseFragBuffer
 Base class for fragmented buffers. More...
 
class  BaseIArchive
 Base class for serialization input archives. More...
 
class  BaseIdentifier
 Base class for data identifier. More...
 
class  BaseIOData
 Base class for data with IO status. More...
 
class  BaseKernel
 Base class for kernel objects. More...
 
class  BaseOArchive
 Base class for serialization output archives. More...
 
class  BaseObjectWithSkeleton
 Base class for serialization object with three serialization modes : More...
 
class  BaseOptData
 Base class for data with optional status. More...
 
class  BaseOwnBuffer
 Base class for buffers with own allocated data. More...
 
class  BasePlanIndexedColl
 Collection of serializable objects indexed by plan. More...
 
class  BasePtrColl
 Base class for collection (std::vector) of shared pointer to serializable objects. More...
 
class  BaseSerializationObject
 Base class for serializable class. More...
 
class  BaseStructuringElement
 Base class for binary structuring element objects. More...
 
class  BaseStructuringElementInfo
 Base class for objects encapsulating informations about binary structuring element objects. More...
 
class  BaseToolTip
 Base class for objects with name and tool tip informations. More...
 
class  BinaryIArchive
 Class for input part of binary serialisation. More...
 
class  BinaryOArchive
 Class for output part of binary serialisation. More...
 
class  Chrono
 Chronometer class for library processing time evaluation. More...
 
struct  ColorGeometryType2Size
 structure used to retrieve number of color plans associated to a given color geometry type More...
 
class  DataIdentifier
 Class used to uniquely identify a data object. More...
 
class  DataIOStatus
 template class used for data io state interpretation More...
 
class  DataItemEnumLeaf
 Concrete class for data item leafs associated to enumerate value. More...
 
class  DataItemLeaf
 Template class for data item leafs instantiation. More...
 
class  DataItemLeafColl
 Template class for collection of data item leafs. More...
 
class  DataItemMap
 Class used to store a variable collection of heterogeneous nodes. More...
 
class  DataItemNodeColl
 Template class used to store data item nodes collection. More...
 
class  DataItemNodeFactory
 Factory singleton allowing dynamic creation of registred data item nodes. More...
 
struct  DataItemValueType2Enum
 structure used to retrieve enumerate value from data item value type More...
 
class  DataOptStatus
 template class used for data optional state interpretation More...
 
struct  DataType2Enum
 structure used to retrieve enumerate value from base type More...
 
class  DoubleIdentifier
 Data identifier associated to a pair of unsigned int values. More...
 
class  DynamicObjectFactory
 Factory singleton allowing dynamic creation of registred objects. More...
 
struct  DynamicRegistrator
 registrator class for dynamic objects More...
 
class  ElementsRange
 Class allowing to store information about elements range (start offset and number of elements) More...
 
struct  Enum2DataItemValueType
 structure used to retrieve dataitem value type from enumerate value More...
 
struct  Enum2DataType
 structure used to retrieve type from enumerate value More...
 
class  ExternalBuffer
 Class allowing to encapsulate sized external data pointer. More...
 
struct  FileReadResult
 structure allowing to store file read results More...
 
class  FragHybridBuffer
 Class allowing to encapsulate an hybrid form of fragment buffer. More...
 
struct  GenRandomUniform
 struct used by the implementation of the functions genRandomUniformValue More...
 
struct  GenRandomUniform< T, typename boost::enable_if_c< boost::is_integral< T >::value >::type >
 
struct  GenRandomUniform< T, typename boost::enable_if_c<!boost::is_integral< T >::value >::type >
 
class  GeometricCalibration
 Class allowing to encapsulate an image geometric calibration. More...
 
class  Guid
 Class encapsulating an auto initialized uuid. More...
 
class  HybridBuffer
 Class allowing to encapsulate an hybrid form of buffer. More...
 
struct  ImageType2Buffer
 structure used to retrieve buffer type from image type More...
 
class  IPSDKBaseDataException
 Exception class for library IPSDKBaseData. More...
 
class  IPSDKSerializationException
 Exception class for library IPSDKSerialization. More...
 
class  IPSDKUtilException
 Exception class for library IPSDKUtil. More...
 
struct  IS2MaskPack
 structure used to retrieve mask pack type from enumerate instruction set value and data type More...
 
struct  IS2Pack
 structure used to retrieve pack type from enumerate instruction set value and data type More...
 
struct  IS2PackType
 structure used to retrieve enumerate pack type value from enumerate instruction set value More...
 
struct  ISAlignmentSize
 structure used to retrieve memory size for a given instruction set alignment More...
 
struct  ISAlignmentType
 structure used to retrieve alignment type associated to a given instruction set More...
 
class  KernelXY
 Class encapsulating a 2d kernel spanning along x and y axis. More...
 
class  KernelXYZ
 Class encapsulating a 3d kernel spanning along x, y and z axis. More...
 
class  LogMessageFormater
 Class alowing to easily format log message and handle id conversions. More...
 
class  LogMessageManager
 Log message manager for ipsdk libraries. More...
 
struct  LowerType
 template structure LowerType<typename T>; its typedef Type gives the type just lower to T. More...
 
struct  NumericLimits
 
class  OffsetXY
 Class encapsulating a 2d offset along x and y axis. More...
 
class  OffsetXYZ
 Class encapsulating a 3d offset along x, y and z axis. More...
 
class  PlanIndex
 Class used to store image plan index. More...
 
class  PlanIndexedColl
 Template class used to store collection of objects indexed by plan. More...
 
class  ProcessingResult
 Class allowing to encapsulate a typed process result associated to a string description. More...
 
class  RandomUniformGenerator
 class exposing the random number generator used by the implementation of the functions genRandomUniformValue, and enabling the modification of the generator seed More...
 
struct  RandomUniformGeneratorSeedLocker
 class setting in its constructor the seed of the random number generator used by the implementation of the functions genRandomUniformValue to a given value, and resetting this seed to time(0) in its destructor this class may be useful when the user wants to generate a "random" sequence of number that is repeatable from one execution to another More...
 
struct  RotationQuaternion
 Quaternion type defined for rotations. More...
 
class  SerializationIItem
 Item used to format inputs during serialization. More...
 
class  SerializationObjectWithGuid
 Serialization object with builtin guid. More...
 
class  SerializationOItem
 Item used to format outputs during serialization. More...
 
class  SingleIdentifier
 Data identifier associated to a single unsigned int value. More...
 
struct  Sse2MaskType
 structure used to retrieve SSE2 mask type associated to a base type More...
 
struct  Sse2Type
 structure used to retrieve SSE2 type associated to a base type More...
 
class  StringIdentifier
 Data identifier associated to a string value. More...
 
class  StructuringElementXY
 Class encapsulating a 2d structuring element spanning along x and y axis. More...
 
class  StructuringElementXYInfo
 Concrete class for objects encapsulating informations about 2d binary structuring element objects. More...
 
class  StructuringElementXYZ
 Class encapsulating a 3d structuring element spanning along x, y and z axis. More...
 
class  StructuringElementXYZInfo
 Concrete class for objects encapsulating informations about 3d binary structuring element objects. More...
 
class  TOwnBuffer
 statically typed buffer class More...
 
class  TypedOwnBuffer
 Dynamically typed buffer class. More...
 
class  UnHandleException
 Class used for rethrow of unhandled exception. More...
 
struct  UpperType
 template structure UpperType<typename T>; its typedef Type gives the type just upper to T. More...
 
struct  UpperType32
 template structure UpperType32<typename T>; its typedef Type gives the type just upper to T without exceeding 32 bits. More...
 
struct  UpperUnsignedType32
 template structure UpperUnsignedType32<typename T>; its typedef Type gives the unsigned type just upper to T without exceeding 32 bits. More...
 
class  XmlIArchive
 Class for input part of xml serialisation. More...
 
class  XmlOArchive
 Class for output part of xml serialisation. More...
 

Typedefs

typedef std::vector< void * > BufferPtrColl
 
typedef std::vector< const void * > BufferConstPtrColl
 
typedef boost::shared_ptr< ipsdk::GeometricCalibrationGeometricCalibrationPtr
 shared pointer to ipsdk::GeometricCalibration
 
typedef boost::shared_ptr< const ipsdk::GeometricCalibrationGeometricCalibrationConstPtr
 shared pointer to const ipsdk::GeometricCalibration
 
typedef struct ipsdk::RotationQuaternion RotationQuaternion
 Quaternion type defined for rotations.
 
typedef std::set< std::string > ItemNames
 collection of names or ids for items
 
typedef boost::shared_ptr< BaseDataItemDataItemPtr
 shared pointer to DataItem
 
typedef boost::shared_ptr< const BaseDataItemDataItemConstPtr
 shared pointer to const DataItem
 
typedef boost::shared_ptr< BaseDataItemLeafDataItemLeafPtr
 shared pointer to DataItemLeaf
 
typedef boost::shared_ptr< BaseDataItemLeafCollDataItemLeafCollPtr
 shared pointer to DataItemLeafColl
 
typedef boost::shared_ptr< BaseDataItemNodeDataItemNodePtr
 shared pointer to DataItemNode
 
typedef boost::shared_ptr< const BaseDataItemNodeDataItemNodeConstPtr
 shared pointer to const DataItemNode
 
typedef boost::shared_ptr< BaseDataItemNodeCollDataItemNodeCollPtr
 shared pointer to DataItemNodeColl
 
typedef boost::shared_ptr< DataItemMapDataItemMapPtr
 shared pointer to DataItemMap
 
typedef boost::shared_ptr< const DataItemMapDataItemMapConstPtr
 shared pointer to const DataItemMap
 
typedef DataItemNodePtr(* DataItemNodeCreator) ()
 data item node creator function
 
typedef boost::shared_ptr< DataIdentifierDataIdentifierPtr
 shared pointer to data identifier
 
typedef boost::shared_ptr< const DataIdentifierDataIdentifierConstPtr
 shared pointer to const data identifier
 
typedef std::set< OffsetXYXYOffsetColl
 collection of xy 2d offsets
 
typedef std::set< OffsetXYZXYZOffsetColl
 collection of xyz 3d offsets
 
typedef boost::shared_ptr< BasePlanIndexedCollPlanIndexedCollPtr
 shared pointer to plan indexed collection
 
typedef boost::shared_ptr< const BasePlanIndexedCollPlanIndexedCollConstPtr
 shared pointer to const plan indexed collection
 
typedef boost::shared_ptr< BaseSerializationObjectSerializationObjectPtr
 shared pointer to a base serialization object
 
typedef boost::shared_ptr< const BaseSerializationObjectSerializationObjectConstPtr
 shared pointer to a const base serialization object
 
typedef boost::weak_ptr< BaseSerializationObjectSerializationObjectWeakPtr
 weak pointer to a base serialization object
 
typedef boost::shared_ptr< BaseDynamicObjectDynamicObjectPtr
 shared pointer to a BaseDynamicObject
 
typedef BaseDynamicObject *(* DynamicNewObjectCreator) ()
 creation function for dynamic objects
 
typedef DynamicObjectPtr(* DynamicSharedObjectCreator) ()
 creation function for shared dynamic objects
 
typedef std::set< eInstructionSetInstructionSetColl
 instruction set collection
 
typedef ipInt32(* EnumStringToIntFunc) (const std::string &enumStrValue)
 defining a function type for string to integer convertions
 
typedef std::set< GuidGuidSet
 collection of unique ordered guid
 
typedef ProcessingResult< bool > BoolResult
 typedef for boolean results associated to a string description
 
typedef boost::shared_ptr< HybridBufferHybridBufferPtr
 shared pointer to HybridBuffer
 
typedef boost::shared_ptr< const HybridBufferHybridBufferConstPtr
 shared pointer to HybridBuffer
 
typedef boost::shared_ptr< ExternalBufferExternalBufferPtr
 shared pointer to ExternalBuffer
 
typedef boost::shared_ptr< const ExternalBufferExternalBufferConstPtr
 shared pointer to ExternalBuffer
 
typedef boost::shared_ptr< TypedOwnBufferTypedOwnBufferPtr
 shared pointer to TypedOwnBuffer
 
typedef boost::shared_ptr< const TypedOwnBufferTypedOwnBufferConstPtr
 shared pointer to TypedOwnBuffer
 
typedef boost::shared_ptr< FragHybridBufferFragHybridBufferPtr
 shared pointer to FragHybridBuffer
 
typedef boost::shared_ptr< const FragHybridBufferFragHybridBufferConstPtr
 shared pointer to FragHybridBuffer
 
typedef DataItemLeaf< ipBoolBoolDataItem
 basic values for data items
 
typedef DataItemLeaf< ipInt8Int8DataItem
 basic values for data items
 
typedef DataItemLeaf< ipUInt8UInt8DataItem
 basic values for data items
 
typedef DataItemLeaf< ipInt16Int16DataItem
 basic values for data items
 
typedef DataItemLeaf< ipUInt16UInt16DataItem
 basic values for data items
 
typedef DataItemLeaf< ipInt32Int32DataItem
 basic values for data items
 
typedef DataItemLeaf< ipUInt32UInt32DataItem
 basic values for data items
 
typedef DataItemLeaf< ipInt64Int64DataItem
 basic values for data items
 
typedef DataItemLeaf< ipUInt64UInt64DataItem
 basic values for data items
 
typedef DataItemLeaf< ipReal32Real32DataItem
 basic values for data items
 
typedef DataItemLeaf< ipReal64Real64DataItem
 basic values for data items
 
typedef DataItemLeaf< std::string > StringDataItem
 basic values for data items
 
typedef DataItemLeaf< boost::filesystem::path > PathDataItem
 basic values for data items
 
typedef DataItemLeafColl< ipBoolBoolVectorDataItem
 
typedef DataItemLeafColl< ipInt8Int8VectorDataItem
 
typedef DataItemLeafColl< ipUInt8UInt8VectorDataItem
 
typedef DataItemLeafColl< ipInt16Int16VectorDataItem
 
typedef DataItemLeafColl< ipUInt16UInt16VectorDataItem
 
typedef DataItemLeafColl< ipInt32Int32VectorDataItem
 
typedef DataItemLeafColl< ipUInt32UInt32VectorDataItem
 
typedef DataItemLeafColl< ipInt64Int64VectorDataItem
 
typedef DataItemLeafColl< ipUInt64UInt64VectorDataItem
 
typedef DataItemLeafColl< ipReal32Real32VectorDataItem
 
typedef DataItemLeafColl< ipReal64Real64VectorDataItem
 
typedef DataItemLeafColl< std::string > StringVectorDataItem
 
typedef DataItemLeafColl< boost::filesystem::path > PathVectorDataItem
 
typedef boost::shared_ptr< KernelXYKernelXYPtr
 shared pointer to KernelXY
 
typedef boost::shared_ptr< const KernelXYKernelXYConstPtr
 shared pointer to KernelXY
 
typedef boost::shared_ptr< KernelXYZKernelXYZPtr
 shared pointer to KernelXYZ
 
typedef boost::shared_ptr< const KernelXYZKernelXYZConstPtr
 shared pointer to KernelXYZ
 
typedef boost::shared_ptr< StructuringElementXYInfoStructuringElementXYInfoPtr
 shared pointer to StructuringElementXYInfo
 
typedef boost::shared_ptr< const StructuringElementXYInfoStructuringElementXYInfoConstPtr
 shared pointer to StructuringElementXYInfo
 
typedef boost::shared_ptr< StructuringElementXYZInfoStructuringElementXYZInfoPtr
 shared pointer to StructuringElementXYZInfo
 
typedef boost::shared_ptr< const StructuringElementXYZInfoStructuringElementXYZInfoConstPtr
 shared pointer to StructuringElementXYZInfo
 
typedef boost::shared_ptr< StructuringElementXYStructuringElementXYPtr
 shared pointer to StructuringElementXY
 
typedef boost::shared_ptr< const StructuringElementXYStructuringElementXYConstPtr
 shared pointer to StructuringElementXY
 
typedef boost::shared_ptr< StructuringElementXYZStructuringElementXYZPtr
 shared pointer to StructuringElementXYZ
 
typedef boost::shared_ptr< const StructuringElementXYZStructuringElementXYZConstPtr
 shared pointer to StructuringElementXYZ
 
typedef std::vector< ipBoolBoolVector
 stl vector collections
 
typedef std::vector< ipInt8Int8Vector
 stl vector collections
 
typedef std::vector< ipUInt8UInt8Vector
 stl vector collections
 
typedef std::vector< ipInt16Int16Vector
 stl vector collections
 
typedef std::vector< ipUInt16UInt16Vector
 stl vector collections
 
typedef std::vector< ipInt32Int32Vector
 stl vector collections
 
typedef std::vector< ipUInt32UInt32Vector
 stl vector collections
 
typedef std::vector< ipInt64Int64Vector
 stl vector collections
 
typedef std::vector< ipUInt64UInt64Vector
 stl vector collections
 
typedef std::vector< ipReal32Real32Vector
 stl vector collections
 
typedef std::vector< ipReal64Real64Vector
 stl vector collections
 
typedef std::vector< std::string > StringVector
 stl vector collections
 
typedef std::vector< boost::filesystem::path > PathVector
 stl vector collections
 
typedef bool ipBool
 Base types definition.
 
typedef int8_t ipInt8
 Base types definition.
 
typedef uint8_t ipUInt8
 Base types definition.
 
typedef int16_t ipInt16
 Base types definition.
 
typedef uint16_t ipUInt16
 Base types definition.
 
typedef int32_t ipInt32
 Base types definition.
 
typedef uint32_t ipUInt32
 Base types definition.
 
typedef int64_t ipInt64
 Base types definition.
 
typedef uint64_t ipUInt64
 Base types definition.
 
typedef float ipReal32
 Base types definition.
 
typedef double ipReal64
 Base types definition.
 

Enumerations

enum  eInstructionSetMessage { eInvalidInstructionSet, eInvalidISAlignment, eTMinGreaterThanTMax }
 Enumerate describing messages. More...
 
enum  eBufferType {
  eBT_OwnTyped, eBT_OwnMutable, eBT_Hybrid, eBT_External,
  eBT_FragHybrid
}
 Enumerate describing buffer types. More...
 
enum  eCalibrationMessage { eInvalidScaleValue }
 Enumerate describing messages. More...
 
enum  eDataItemMessage {
  eInvalidDataItemTypeEnumValue, eInvalidDataItemValueTypeEnumValue, eInvalidEnumIntValue, eInvalidEnumStrValue,
  eInvalidNodeIndex, eItemAlreadyExists, eItemDoesNotExist, eNodeAlreadyRegistred,
  eNodeNameDoesNotExists, eNodeNotRegistredCanAccess, eNodeNotRegistredCanRemove, eNullItemPtr
}
 Enumerate describing messages. More...
 
enum  eDataItemType {
  eDIT_Leaf, eDIT_Node, eDIT_LeafColl, eDIT_NodeColl,
  eDIT_Map
}
 Enumerate describing data items type. More...
 
enum  eDataItemValueType {
  eDIVT_Bool, eDIVT_Int8, eDIVT_UInt8, eDIVT_Int16,
  eDIVT_UInt16, eDIVT_Int32, eDIVT_UInt32, eDIVT_Int64,
  eDIVT_UInt64, eDIVT_Real32, eDIVT_Real64, eDIVT_String,
  eDIVT_Path, eDIVT_Enum
}
 Enumerate describing data items value type. More...
 
enum  eIOStatus { eIOS_Input, eIOS_Output, eIOS_InOut }
 Enumerate describing data input/output status. More...
 
enum  eOptStatus { eOS_Mandatory, eOS_Optional }
 Enumerate describing data optional status. More...
 
enum  eDiscreteOrientation2d {
  eDO2D_YMXM, eDO2D_YMX0, eDO2D_YMXP, eDO2D_Y0XM,
  eDO2D_Y0XP, eDO2D_YPXM, eDO2D_YPX0, eDO2D_YPXP
}
 Enumerate describing discrete orientation 2d. More...
 
enum  eDiscreteOrientation3d {
  eDO3D_ZMYMXM, eDO3D_ZMYMX0, eDO3D_ZMYMXP, eDO3D_ZMY0XM,
  eDO3D_ZMY0X0, eDO3D_ZMY0XP, eDO3D_ZMYPXM, eDO3D_ZMYPX0,
  eDO3D_ZMYPXP, eDO3D_Z0YMXM, eDO3D_Z0YMX0, eDO3D_Z0YMXP,
  eDO3D_Z0Y0XM, eDO3D_Z0Y0XP, eDO3D_Z0YPXM, eDO3D_Z0YPX0,
  eDO3D_Z0YPXP, eDO3D_ZPYMXM, eDO3D_ZPYMX0, eDO3D_ZPYMXP,
  eDO3D_ZPY0XM, eDO3D_ZPY0X0, eDO3D_ZPY0XP, eDO3D_ZPYPXM,
  eDO3D_ZPYPX0, eDO3D_ZPYPXP
}
 Enumerate describing discrete orientation 3d. More...
 
enum  eIPSDKBaseDataMessage {
  eBufferAllocationFailed, eBufferNotInitialized, eCantSetFragmentPtrOnOwn, eInvalidBufferType,
  eInvalidFragmentIndex, eKeyAlreadyExists, eUnknownKey
}
 Enumerate describing messages. More...
 
enum  eNeighborhood2dType { eN2T_4Connexity, eN2T_8Connexity }
 Enumerate describing neighborhood 2d type. More...
 
enum  eNeighborhood3dType { eN3T_6Connexity, eN3T_18Connexity, eN3T_26Connexity }
 Enumerate describing neighborhood 3d type. More...
 
enum  eSobelKernelType { eSKT_ScharrHalfKnlSz1, eSKT_SobelHalfKnlSz1, eSKT_SobelHalfKnlSz2, eSKT_SobelHalfKnlSz3 }
 Enumerate describing Sobel gradient kernels. More...
 
enum  eKernelMessage {
  eCantInsert, eCantReplace, eCantRemove, eCantGetValue,
  eInvalidGaussianCoverage, eInvalidGaussianRatio, eInvalidStdDevX, eInvalidStdDevY,
  eInvalidStdDevZ, eKernelSizeMustBeOdd, eKernelXYSizeMismatch, eKernelXYZSizeMismatch,
  eSigmaXCloseToSigmaY, eNoKernelRotation2d
}
 Enumerate describing messages. More...
 
enum  eKernelType { eKT_XY, eKT_XYZ }
 Enumerate describing kernel type. More...
 
enum  eSEXYSubType {
  eSEXY_Generic, eSEXY_Circular, eSEXY_Square, eSEXY_Rectangular,
  eSEXY_HalfLinear, eSEXY_Linear
}
 Enumerate describing binary structuring element 2d sub type. More...
 
enum  eSEXYZSubType {
  eSEXYZ_Generic, eSEXYZ_Spherical, eSEXYZ_Cubic, eSEXYZ_Rectangular,
  eSEXYZ_HalfLinear, eSEXYZ_Linear
}
 Enumerate describing binary structuring element 3d sub type. More...
 
enum  eStructuringElementMessage {
  eCantInsert, eCantRemove, eInvalidRadius, eSEInfoNotInit,
  eSEInfoInvalidSubType
}
 Enumerate describing messages. More...
 
enum  eStructuringElementType { eSET_XY, eSET_XYZ }
 Enumerate describing binary structuring element type. More...
 
enum  ePlanIndexMessage { eCantGetElement, eCantInsertElement, eInvalidPlanOffset, eNullSharedPtr }
 Enumerate describing messages. More...
 
enum  eSklSrzMode { eSSM_Full, eSSM_Skeleton, eSSM_Data }
 Enumerate describing serialization mode for objects with skeleton. More...
 
enum  eIPSDKSerializationMessage {
  eArchiveBadDataType, eArchiveDataReadError, eArchiveDataReadErrorOnLine, eArchiveDataWriteError,
  eBinaryCantReadFile, eBinaryCantReadObject, eBinaryCantWrite, eBinaryCantWriteNullSharedPtr,
  eClassNameMismatch, eClassReadDataError, eClassReadDataException, eClassVersionAlreadyRegistred,
  eClassVersionNotRegistred, eClassWriteDataError, eEndSubSectionError, eExceptionReadingBinaryFile,
  eExceptionReadingBinaryObject, eExceptionReadingXmlFile, eExceptionReadingXmlObject, eExceptionWritingBinary,
  eExceptionWritingXml, eInvalidArchiveFooter, eInvalidArchiveHeader, eInvalidGuidSavedValue,
  eInvalidObjectId, eInvalidReadClassVersion, eInvalidSavedEnumString, eInvalidSavedEnumValue,
  eNullPtrAsRef, eSharedObjectAlreadyDeleted, eVariantSrzError, eXmlCantReadFile,
  eXmlCantReadObject, eXmlCantWrite, eXmlCantWriteNullSharedPtr
}
 Enumerate describing messages. More...
 
enum  eDataType {
  eDT_None, eDT_Bool, eDT_Int8, eDT_UInt8,
  eDT_Int16, eDT_UInt16, eDT_Int32, eDT_UInt32,
  eDT_Int64, eDT_UInt64, eDT_Real32, eDT_Real64
}
 Enumerate describing a base type. More...
 
enum  eInstructionSet {
  eIS_Standard, eIS_Sse2, eIS_Sse3, eIS_Sse41,
  eIS_Sse42, eIS_Avx, eIS_Fma3, eIS_Avx2,
  eIS_Avx512
}
 Enumerate for processor instruction set description. More...
 
enum  eISAlignment {
  eISA_None, eISA_8Bytes, eISA_16Bytes, eISA_32Bytes,
  eISA_64Bytes
}
 Enumerate describing memory data alignments. More...
 
enum  eIPSDKUtilErrors {
  eCanFindCommonDataDirectory, eCanFindUserDataDirectory, eCanGetUserHome, eCantCopyObject,
  eCantCreateFile, eClassAlreadyRegistred, eClassNotRegistredCantCreate, eClassNotRegistredCantRemove,
  eCmdExecutionFailed, eFailedToCreateProcess, eFailedToReadDataFromFile, eFailedToWriteDataToFile,
  eFileNotExists, eFileReadAccess, eInvalidPythonVersionFormat, eInvalidSDKStrProductInfoType,
  eInvalidSDKVersionElementType, eInvalidSDKVersionStringType, eMsgFileInvalidContent, eMsgFileInvalidId,
  eMsgIdAlreadyExists, eMsgMsgIdAlreadyExists, eProcessTimeOut, eProjectRootDirectoryNotSet,
  eUnHandleEnumValue, eUnknownMsgId, eCouldNotOpenInputFileForCopy, eCouldNotOpenOutputFileForCopy,
  eCouldNotCopyFile
}
 Enumerate describing messages. More...
 
enum  eInternalDirectory { eID_Resources, eID_Images, eID_Python }
 Enumerate describing IPSDK internal directories. More...
 
enum  eDefaultExternalDirectory {
  eDED_Tmp, eDED_CommonConfig, eDED_UserConfig, eDED_MainLog,
  eDED_IdentityCheck1, eDED_IdentityCheck2
}
 Enumerate describing IPSDK default external directories. More...
 
enum  eDefaultInternalLibraryResourcePath { eDILR_ProductLogo, eDILR_CompanyLogo }
 Enumerate describing default internal library resources path. More...
 
enum  eDefaultExternalLibraryResourcePath {
  eDELR_CommonLicense, eDELR_UserLicense, eDELR_CommonLocalProcessingPolicy, eDELR_UserLocalProcessingPolicy,
  eDELR_CommonDistributedProcessingPolicy, eDELR_UserDistributedProcessingPolicy, eDELR_CommonNetworkConfiguration, eDELR_UserNetworkConfiguration,
  eDELR_InstallationLicense
}
 Enumerate describing default external library resources path. More...
 
enum  eSDKVersionElementType { eSVET_FirstMajor, eSVET_SecondMajor, eSVET_FirstMinor, eSVET_SecondMinor }
 Enumerate describing sdk version elements. More...
 
enum  eSDKStrVersionType { eSSVT_Dot, eSSVT_Underscore }
 Enumerate describing sdk version string format. More...
 
enum  eSDKVersionStatus { eSVS_RTM, eSVS_Beta }
 Enumerate describing sdk version status. More...
 
enum  eSDKStrProductInfoType { eSSPIT_ProductName, eSSPIT_LongProductName, eSSPIT_CompanyName, eSSPIT_Copyright }
 Enumerate describing product information string format. More...
 

Functions

IPSDKUTIL_API eISAlignment getAlignmentType (const eInstructionSet &instructionSet)
 
IPSDKUTIL_API ipUInt8 getAlignmentSize (const eInstructionSet &instructionSet)
 
IPSDKUTIL_API ipUInt8 getAlignmentSize (const eISAlignment &alignmentType)
 
IPSDKUTIL_API ipUInt32 getNbEltsPerOp (const eInstructionSet &instructionSet)
 
IPSDKUTIL_API ipUInt32 getMaxNbEltsPerOp ()
 
IPSDKBASEDATA_API ipUInt32 getBufferBaseSize (const eDataType &dataType)
 recovery of buffer size from its type (in octets)
 
IPSDKBASEDATA_API void copyBuffer (void *pOutput, const ipUInt64 size, const void *pInput)
 copy of buffer data
 
IPSDKBASEDATA_API void copyBuffer (void *pOutput, const eDataType &dataType, const ipUInt64 size, const void *pInput)
 copy of buffer data
 
template<typename T >
IPSDKBASEDATA_API void copyBuffer (T *pOutput, const ipUInt64 size, const T *pInput)
 copy of buffer data
 
IPSDKBASEDATA_API void copyBufferMiror (void *pOutput, const eDataType &dataType, const ipUInt64 size, const void *pInput)
 copy of buffer mirroring data More...
 
template<typename T >
IPSDKBASEDATA_API void copyBufferMiror (T *pOutput, const ipUInt64 size, const T *pInput)
 copy of buffer mirroring data
 
IPSDKBASEDATA_API void setBufferValues (const ipReal64 value, const eDataType &dataType, const ipUInt64 size, void *pBuf)
 set buffer values to a given constant value More...
 
template<typename T >
IPSDKBASEDATA_API void setBufferValues (const T value, const ipUInt64 size, T *pBuf)
 set buffer values to a given constant value
 
IPSDKBASEDATA_API bool equal (const BaseDataItem &dataItem1, const BaseDataItem &dataItem2, const ipReal64 &tolerance=NumericLimits< ipReal64 >::sqrt_epsilon())
 function allowing to check whether two data items are equal
 
template<typename T >
SerializationOItem< T > make_oitem (const std::string &itemName, const T &value)
 template function allowing to dynamically create SerializationOItem
 
template<typename T >
SerializationIItem< T > make_iitem (const std::string &itemName, T &value)
 template function allowing to dynamically create SerializationIItem
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eDiscreteOrientation2d)
 serialization operators for eDiscreteOrientation2d enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eDiscreteOrientation3d)
 serialization operators for eDiscreteOrientation3d enumerate
 
IPSDKBASEDATA_API const std::string & getIPSDKBaseDataLoggerName ()
 Recovery of logger name associated to library.
 
IPSDKBASEDATA_API log4cplus::Logger & getIPSDKBaseDataLogger ()
 Recovery of logger associated to library.
 
IPSDKBASEDATA_API const LogMessageManagergetIPSDKBaseDataLogMessageManager ()
 Recovery of message manager associated to library.
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eNeighborhood2dType)
 serialization operators for eNeighborhood2dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eNeighborhood3dType)
 serialization operators for eNeighborhood3dType enumerate
 
IPSDKBASEDATA_API void separableGaussianSmoothing (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYPtr &pXAxisKernel, KernelXYPtr &pYAxisKernel)
 function allowing to generate a separable 2d gaussian kernel used for smoothing operation More...
 
IPSDKBASEDATA_API void separableGaussianSmoothing (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 stdDevZ, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYZPtr &pXAxisKernel, KernelXYZPtr &pYAxisKernel, KernelXYZPtr &pZAxisKernel)
 function allowing to generate a separable 3d gaussian kernel used for smoothing operation More...
 
IPSDKBASEDATA_API void separableGaussianGradient (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYPtr &pXAxisKernel, KernelXYPtr &pYAxisKernel)
 function allowing to generate a separable 2d gaussian kernel used for gradient computation operation More...
 
IPSDKBASEDATA_API void separableGaussianGradient (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 stdDevZ, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYZPtr &pXAxisKernel, KernelXYZPtr &pYAxisKernel, KernelXYZPtr &pZAxisKernel)
 function allowing to generate a separable 3d gaussian kernel used for gradient computation operation More...
 
IPSDKBASEDATA_API void separableGaussianHessian (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYPtr &pXAxisKernel, KernelXYPtr &pYAxisKernel)
 function allowing to generate a separable 2d Hessian kernel used for Hessian computation operation More...
 
IPSDKBASEDATA_API void separableGaussianHessian (const ipReal32 stdDevX, const ipReal32 stdDevY, const ipReal32 stdDevZ, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYZPtr &pXAxisKernel, KernelXYZPtr &pYAxisKernel, KernelXYZPtr &pZAxisKernel)
 function allowing to generate a separable 3d Hessian kernel used for Hessian computation operation More...
 
IPSDKBASEDATA_API void createOrientedGaussianSmoothingKernel (const ipReal32 theta, const ipReal32 sigmaX, const ipReal32 sigmaY, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYPtr &pKernelX, KernelXYPtr &pKernelY)
 function allowing to create an oriented Gaussian gradient 2d kernel
 
IPSDKBASEDATA_API void createOrientedGaussianGradientKernel (const ipReal32 theta, const ipReal32 sigmaX, const ipReal32 sigmaY, const ipReal32 gaussianRatio, const ipUInt32 minHalfKernelSize, KernelXYPtr &pKernelX, KernelXYPtr &pKernelY)
 
IPSDKBASEDATA_API KernelXYPtr rotate2dKernel (const ipReal32 theta, const KernelXYConstPtr pKnl)
 function allowing to create a rotated version of the input 2d kernel
 
IPSDKBASEDATA_API void separableSobelSmoothing (const eSobelKernelType &kernelType, KernelXYPtr &pXAxisKernel, KernelXYPtr &pYAxisKernel)
 function allowing to generate a separable 2d Sobel kernel used for smoothing operation
 
IPSDKBASEDATA_API void separableSobelSmoothing (const eSobelKernelType &kernelType, KernelXYZPtr &pXAxisKernel, KernelXYZPtr &pYAxisKernel, KernelXYZPtr &pZAxisKernel)
 function allowing to generate a separable 3d Sobel kernel used for smoothing operation
 
IPSDKBASEDATA_API void separableSobelGradient (const eSobelKernelType &kernelType, KernelXYPtr &pXAxisKernel, KernelXYPtr &pYAxisKernel)
 function allowing to generate a separable 2d Sobel kernel used for gradient computation operation
 
IPSDKBASEDATA_API void separableSobelGradient (const eSobelKernelType &kernelType, KernelXYZPtr &pXAxisKernel, KernelXYZPtr &pYAxisKernel, KernelXYZPtr &pZAxisKernel)
 function allowing to generate a separable 3d Sobel kernel used for gradient computation operation
 
IPSDKBASEDATA_API KernelXYPtr squareKernelXY (const ipUInt32 halfKernelSize, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a square XY kernel More...
 
IPSDKBASEDATA_API KernelXYPtr rectangularKernelXY (const ipUInt32 halfKernelSizeX, const ipUInt32 halfKernelSizeY, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a rectangular XY kernel More...
 
IPSDKBASEDATA_API KernelXYPtr linearKernelXY (const ipReal32 theta, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a linear oriented XY kernel with a given number of elements. More...
 
IPSDKBASEDATA_API KernelXYPtr linearInterpolatedKernelXY (const ipReal32 theta, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a linear oriented XY kernel with interpolated coefficients. More...
 
IPSDKBASEDATA_API KernelXYZPtr cubicKernelXYZ (const ipUInt32 halfKernelSize, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a cubic XYZ kernel More...
 
IPSDKBASEDATA_API KernelXYZPtr rectangularKernelXYZ (const ipUInt32 halfKernelSizeX, const ipUInt32 halfKernelSizeY, const ipUInt32 halfKernelSizeZ, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a rectangular parallelepiped XYZ kernel More...
 
IPSDKBASEDATA_API KernelXYZPtr linearKernelXYZ (const ipReal32 theta, const ipReal32 phi, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a linear oriented XYZ kernel with a given number of elements. More...
 
IPSDKBASEDATA_API KernelXYZPtr linearInterpolatedKernelXYZ (const ipReal32 theta, const ipReal32 phi, const Real32Vector &valueColl, const ipBool bKeepNullValue=false)
 function allowing to generate a linear oriented XYZ kernel with interpolated coefficients. More...
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr genericSEXYInfo (const StructuringElementXY &seXY)
 function allowing to generate a generic structuring element (SE)
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr emptySEXYInfo ()
 function allowing to generate an empty XY structuring element (SE)
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr squareSEXYInfo (const ipUInt32 halfSESize)
 function allowing to generate a square XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr rectangularSEXYInfo (const ipUInt32 halfSESizeX, const ipUInt32 halfSESizeY)
 function allowing to generate a rectangular XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr circularSEXYInfo (const ipReal64 radius)
 function allowing to generate a filled circular XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr halfLinearSEXYInfo (const ipReal64 theta, const ipReal64 radius)
 function allowing to generate a half linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYInfoPtr linearSEXYInfo (const ipReal64 theta, const ipReal64 radius)
 function allowing to generate a linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr genericSEXYZInfo (const StructuringElementXYZ &seXYZ)
 function allowing to generate a generic structuring element (SE)
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr emptySEXYZInfo ()
 function allowing to generate an empty XYZ structuring element (SE)
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr cubicSEXYZInfo (const ipUInt32 halfSESize)
 function allowing to generate a cubic XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr rectangularSEXYZInfo (const ipUInt32 halfSESizeX, const ipUInt32 halfSESizeY, const ipUInt32 halfSESizeZ)
 function allowing to generate a rectangular parallelepiped XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr sphericalSEXYZInfo (const ipReal64 radius)
 function allowing to generate a filled spherical XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr halfLinearSEXYZInfo (const ipReal64 theta, const ipReal64 phi, const ipReal64 radius)
 function allowing to generate a half linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZInfoPtr linearSEXYZInfo (const ipReal64 theta, const ipReal64 phi, const ipReal64 radius)
 function allowing to generate a linear structuring element (SE) More...
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eSEXYSubType)
 serialization operators for eSEXYSubType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseData, eSEXYZSubType)
 serialization operators for eSEXYZSubType enumerate
 
IPSDKBASEDATA_API StructuringElementXYPtr squareSEXY (const ipUInt32 halfSESize)
 function allowing to generate a square XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYPtr rectangularSEXY (const ipUInt32 halfSESizeX, const ipUInt32 halfSESizeY)
 function allowing to generate a rectangular XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYPtr circularSEXY (const ipReal64 radius)
 function allowing to generate a filled circular XY structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYPtr halfLinearSEXY (const ipReal64 theta, const ipReal64 radius)
 function allowing to generate a half linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYPtr linearSEXY (const ipReal64 theta, const ipReal64 radius)
 function allowing to generate a linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZPtr cubicSEXYZ (const ipUInt32 halfSESize)
 function allowing to generate a cubic XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZPtr rectangularSEXYZ (const ipUInt32 halfSESizeX, const ipUInt32 halfSESizeY, const ipUInt32 halfSESizeZ)
 function allowing to generate a rectangular parallelepiped XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZPtr sphericalSEXYZ (const ipReal64 radius)
 function allowing to generate a filled spherical XYZ structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZPtr halfLinearSEXYZ (const ipReal64 theta, const ipReal64 phi, const ipReal64 radius)
 function allowing to generate a half linear structuring element (SE) More...
 
IPSDKBASEDATA_API StructuringElementXYZPtr linearSEXYZ (const ipReal64 theta, const ipReal64 phi, const ipReal64 radius)
 function allowing to generate a linear structuring element (SE) More...
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaResultType)
 serialization operators for ipsdk::image::tools::eImageFormulaResultType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaImageType)
 serialization operators for ipsdk::image::tools::eImageFormulaImageType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaOperatorType)
 serialization operators for ipsdk::image::tools::eImageFormulaOperatorType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaUnaryArithmeticFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaUnaryArithmeticFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaBinaryArithmeticFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaBinaryArithmeticFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaTernaryLogicFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaTernaryLogicFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaDynamicConstant)
 serialization operators for ipsdk::image::tools::eImageFormulaDynamicConstant enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaImageConstant)
 serialization operators for ipsdk::image::tools::eImageFormulaImageConstant enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eFormulaImageId)
 serialization operators for ipsdk::image::tools::eFormulaImageId enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaGenericArithmeticFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaGenericArithmeticFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaCoupledArithmeticFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaCoupledArithmeticFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaStructuringElement)
 serialization operators for ipsdk::image::tools::eImageFormulaStructuringElement enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKBaseImageTools, ipsdk::image::tools::eImageFormulaMapFunctionType)
 serialization operators for ipsdk::image::tools::eImageFormulaMapFunctionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKComm, tcpip::eIPAddressType)
 serialization operators for eIPAddressType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKGeometry, geom::eHoleMsrPolicy)
 serialization operators for eHoleMsrPolicy enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKImage, image::eBorder2dType)
 serialization operators for eBorder2dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKImage, image::eValuedBorder2dType)
 serialization operators for eValuedBorder2dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKImage, image::eBorder3dType)
 serialization operators for eBorder3dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKImage, image::eValuedBorder3dType)
 serialization operators for eValuedBorder3dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKImage, ipsdk::image::eDataAccessMode)
 serialization operators for ipsdk::image::eDataAccessMode enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKMath, math::eDataPartitionType)
 serialization operators for eDataPartitionType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKMath, math::eRobustEstimationType)
 serialization operators for eRobustEstimationType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKMath, ipsdk::math::transform::eGeometricTransform2dType)
 serialization operators for eGeometricTransform2dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKMath, ipsdk::math::transform::eGeometricTransform3dType)
 serialization operators for eGeometricTransform3dType enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKMath, ipsdk::math::eHistogramOutOfBoundsPolicy)
 serialization operators for ipsdk::math::eHistogramOutOfBoundsPolicy enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKSerialization, eInstructionSet)
 serialization operators for eInstructionSet enumerate
 
 IPSDK_DECLARE_SERIAL_ENUM (IPSDKSerialization, eDataType)
 serialization operators for eDataType enumerate
 
template<typename T >
boost::enable_if_c< boost::mpl::and_< typename boost::is_base_of< ipsdk::BaseSerializationObject, T >::type, typename boost::mpl::not_< typename boost::is_same< ipsdk::BaseSerializationObject, T >::type >::type >::value, ipsdk::BaseIArchive & >::type operator>> (ipsdk::BaseIArchive &ar, const ipsdk::SerializationIItem< T *> &item)
 
IPSDKSERIALIZATION_API const std::string & getIPSDKSerializationLoggerName ()
 Recovery of logger name associated to library.
 
IPSDKSERIALIZATION_API log4cplus::Logger & getIPSDKSerializationLogger ()
 Recovery of logger associated to library.
 
IPSDKSERIALIZATION_API const LogMessageManagergetIPSDKSerializationLogMessageManager ()
 Recovery of message manager associated to library.
 
template<typename T >
void copyDynamicObjectPtr (const boost::scoped_ptr< T > &pInput, boost::scoped_ptr< T > &pOutput)
 copy of scoped pointer to BaseDynamicObject derived type More...
 
template<typename T >
void copyDynamicObjectPtr (const boost::shared_ptr< T > &pInput, boost::shared_ptr< T > &pOutput)
 copy of shared pointer to BaseDynamicObject derived type More...
 
IPSDKUTIL_API const std::string & getBaseLoggerName ()
 Recovery of main logger name associated to library.
 
IPSDKUTIL_API log4cplus::Logger & getBaseLogger ()
 Recovery of main logger associated to library.
 
IPSDKUTIL_API const std::string & getIPSDKUtilLoggerName ()
 Recovery of logger name associated to library.
 
IPSDKUTIL_API log4cplus::Logger & getIPSDKUtilLogger ()
 Recovery of logger associated to library.
 
IPSDKUTIL_API const LogMessageManagergetIPSDKUtilLogMessageManager ()
 Recovery of message manager associated to library.
 
IPSDKUTIL_API bool hasAppender (const log4cplus::Logger &logger)
 function allowing to check whether a logger is associated to an appender
 
IPSDKUTIL_API void logMessage (log4cplus::Logger &logger, const log4cplus::LogLevel &logLevel, const std::string &message, const std::string &fileName, const ipInt32 lineNumber)
 function allowing to log a message
 
IPSDKUTIL_API std::string getFormatedTime ()
 function allowing to retrieve formatted date and time string More...
 
template<typename T >
IPSDK_FORCEINLINE T genRandomUniformValue (const T &minVal, const T &maxVal)
 generates a random value of type T on the range [minVal, maxVal]
 
template<typename T >
IPSDK_FORCEINLINE T genRandomUniformValue ()
 generates a random value of type T on the range [min value for type T, max
 
IPSDKUTIL_API void setProjectRootDirectory (const boost::filesystem::path &projectRootDirectory)
 function allowing to select project root directory
 
IPSDKUTIL_API bool isSetProjectRootDirectory ()
 function allowing to check whether project root directory has been set
 
IPSDKUTIL_API const boost::filesystem::path & getProjectRootDirectory ()
 function allowing to retrieve project root directory More...
 
IPSDKUTIL_API boost::filesystem::path getIPSDKRootDirectory ()
 function allowing to retrieve IPSDK installation root directory
 
IPSDKUTIL_API boost::filesystem::path getIPSDKDirectory (const eInternalDirectory &dirId)
 retrieve ipsdk internal directory
 
IPSDKUTIL_API boost::filesystem::path getProjectDirectory (const eInternalDirectory &dirId)
 retrieve project internal directory
 
IPSDKUTIL_API boost::filesystem::path getSubDirectory (const eInternalDirectory &dirId)
 retrieve relative subdirectory associated to a given id More...
 
IPSDKUTIL_API boost::filesystem::path getIPSDKDefaultDirectory (const eDefaultExternalDirectory &dirId)
 retrieve ipsdk default external directory More...
 
IPSDKUTIL_API boost::filesystem::path getIPSDKDefaultResourcePath (const eDefaultInternalLibraryResourcePath &resId)
 retrieve IPSDK default internal resource file
 
IPSDKUTIL_API boost::filesystem::path getProjectDefaultResourceSubPath (const eDefaultInternalLibraryResourcePath &resId)
 retrieve Project default internal resource file relative path
 
IPSDKUTIL_API boost::filesystem::path getProjectDefaultResourcePath (const eDefaultInternalLibraryResourcePath &resId)
 retrieve Project default internal resource file
 
IPSDKUTIL_API boost::filesystem::path getIPSDKDefaultResourcePath (const eDefaultExternalLibraryResourcePath &resId)
 retrieve IPSDK default external resource file
 
IPSDKUTIL_API boost::filesystem::path getRelativePath (const boost::filesystem::path &fromPath, const boost::filesystem::path &toPath)
 
IPSDKUTIL_API boost::filesystem::path getRelativeFromRoot (const boost::filesystem::path &rootPath, const boost::filesystem::path &subPath)
 
IPSDKUTIL_API std::string getPythonExecName ()
 function allowing to retrieve python executable name
 
IPSDKUTIL_API std::string getPythonRootDirEnvVarName (const ipUInt32 pythonMajorVersion, const ipUInt32 pythonMinorVersion)
 function allowing to retrieve environment variable name which allows to retrieve root path to python distribution for a given python version
 
IPSDKUTIL_API boost::filesystem::path getPythonRootDir (const ipUInt32 pythonMajorVersion, const ipUInt32 pythonMinorVersion)
 function allowing to retrieve path to python executable for a given version from environment if it exits More...
 
IPSDKUTIL_API boost::filesystem::path getPythonExecPathFromEnvVar (const ipUInt32 pythonMajorVersion, const ipUInt32 pythonMinorVersion)
 function allowing to retrieve python executable path from environment variable associated to a given python version More...
 
IPSDKUTIL_API BoolResult getPythonExecVersion (const boost::filesystem::path &pythonExecPath, ipUInt32 &majorVersion, ipUInt32 &minorVersion, ipUInt32 &microVersion)
 function allowing to retrieve python executable version More...
 
IPSDKUTIL_API ipUInt32 getSDKVersionElement (const eSDKVersionElementType &sdkVersionElementType)
 retrieve version element for sdk More...
 
IPSDKUTIL_API const std::string & getSDKStrVersion (const eSDKStrVersionType &sdkStrVersionType)
 retrieve string formated version for sdk More...
 
IPSDKUTIL_API eSDKVersionStatus getSDKVersionStatus ()
 retrieve sdk version status
 
IPSDKUTIL_API const std::string & getSDKSvnRevision ()
 retrieve svn revision version for library
 
IPSDKUTIL_API const std::string & getSDKProductInfo (const eSDKStrProductInfoType &sdkStrProductInfoType)
 retrieve string informations about product More...
 
IPSDKUTIL_API const std::string & getProductTypeName ()
 retrieve product type name
 
IPSDKUTIL_API const std::string & getBinarySuffixDebug ()
 retrieve suffix associated to library binary debug files
 
IPSDKUTIL_API const std::string & getBinarySuffixRelease ()
 retrieve suffix associated to library binary release files
 
IPSDKUTIL_API void readLine (std::istream &is, std::string &strLine)
 function allowing to read a line from a stream More...
 
IPSDKUTIL_API int copyFile (const boost::filesystem::path &inPath, const boost::filesystem::path &outPath)
 function allowing to copy a file More...
 
IPSDKUTIL_API const std::vector< std::string > splitString (const std::string &strIn, const char delimiter)
 split a std::string into a std::vector<std::string>
 
IPSDKUTIL_API std::string getHostName ()
 retrieve local host name More...
 
IPSDKUTIL_API std::string getPlatformBinaryName (const std::string &baseName)
 retrieve full ipsdk (platform dependent) binary name from its base name
 
IPSDKUTIL_API std::string getPlatformLibraryName (const std::string &baseName)
 retrieve full ipsdk (platform dependent) library name from its base name
 
IPSDKUTIL_API std::string getPlatformExecName (const std::string &baseName)
 retrieve full ipsdk (platform dependent) executable name from its base name
 
IPSDKUTIL_API std::string getPlatformBinaryDirPostFix ()
 retrieve platform dependent binary directory post fix. Example : msvc11_x64, linux_x64, ...
 
IPSDKUTIL_API BoolResult loadLibrary (const boost::filesystem::path &filePath)
 load library given its path More...
 
IPSDKUTIL_API BoolResult addLibraryDirectory (const boost::filesystem::path &dirPath)
 add a library directory for library delay load search More...
 
IPSDKUTIL_API std::string getPlatformName ()
 retrieve platform name More...
 
IPSDKUTIL_API bool is64BitsConfig ()
 retrieve x64 flag More...
 
IPSDKUTIL_API bool isDebugConfig ()
 retrieve debug flag More...
 
IPSDKUTIL_API std::string getFullPlatformName ()
 retrieve full platform name More...
 
IPSDKUTIL_API std::string getOSName ()
 retrieve full operating system name More...
 
IPSDKUTIL_API BoolResult displayHtml (const boost::filesystem::path &filePath)
 display html file through default browser More...
 
IPSDKUTIL_API BoolResult getApplicationPath (boost::filesystem::path &appPath)
 retrieve application path More...
 
IPSDKUTIL_API BoolResult getApplicationDir (boost::filesystem::path &appDir)
 retrieve application directory More...
 
IPSDKUTIL_API BoolResult getApplicationName (std::string &appName)
 retrieve application name More...
 
IPSDKUTIL_API BoolResult getUserRootDataDir (boost::filesystem::path &dataPath)
 retrieve root user data directory More...
 
IPSDKUTIL_API BoolResult getCommonRootDataDir (boost::filesystem::path &dataPath)
 retrieve root common (all users) data directory More...
 
IPSDKUTIL_API BoolResult getUserLibraryDataDir (boost::filesystem::path &dataPath)
 retrieve library user data directory More...
 
IPSDKUTIL_API BoolResult getCommonLibraryDataDir (boost::filesystem::path &dataPath)
 retrieve library common data directory More...
 
IPSDKUTIL_API std::string getLastError (ipInt32 errorCode)
 function allowing to retrieve error string from value
 
IPSDKUTIL_API std::string getLastError ()
 function allowing to retrieve last global error string
 
IPSDKUTIL_API void setThreadName (const std::string &threadName)
 function allowing to set current thread name for debugging purpose More...
 
IPSDKUTIL_API BoolResult createProcess (const boost::filesystem::path &execPath, const std::string &cmdArgs, const ipUInt32 timeout, ipInt32 &exitCode)
 
IPSDKUTIL_API BoolResult createProcess (const boost::filesystem::path &execPath, const std::string &cmdArgs, std::string &stdOutStr)
 
IPSDKUTIL_API std::string getSvnAppVersion ()
 retrieve version for Svn revision control system
 
IPSDKUTIL_API std::string getCMakeAppVersion ()
 retrieve version for CMake build system
 
IPSDKUTIL_API std::string getBoostVersion ()
 retrieve version for boost library
 
IPSDKUTIL_API std::string getLog4cplusVersion ()
 retrieve version for log4cplus library
 
IPSDKUTIL_API std::string getLibTiffVersion ()
 retrieve version for libtiff library
 
IPSDKUTIL_API std::string getOpenSSLVersion ()
 retrieve version for openSSL library
 
IPSDKUTIL_API std::string getQtVersion ()
 retrieve version for Qt library
 
IPSDKUTIL_API std::vector< std::pair< ipUInt32, ipUInt32 > > getPythonAvailableVersions ()
 retrieve available versions for python library More...
 
bool comparePatchBasedBilateralParams (const imaproc::attr::PatchBasedBilateralParams &outParams, const imaproc::attr::PatchBasedBilateralParams &refParams, const ipReal64 paramsCompareTol, const std::string &msgPrefix)
 
bool comparePlanIndexedPatchBasedBilateralParams (const imaproc::attr::PlanIndexedPatchBasedBilateralParams &outPIParams, const imaproc::attr::PlanIndexedPatchBasedBilateralParams &refPIParams, const ipReal64 paramsCompareTol, const std::string &msgPrefix)
 
void comparePatchBilateralResults (const image::ImagePtr &pOutImg, const imaproc::attr::PatchBasedBilateralParams &outParams, const boost::filesystem::path &refImgPath, const imaproc::attr::PatchBasedBilateralParams &refParams, const ipReal64 imgCompareAbsTol, const ipReal64 imgCompareRelTol, const ipReal64 paramsCompareTol, const std::string &msgPrefix)
 
void compareMultiSlicePatchBilateralResults (const image::ImagePtr &pOutImg, const imaproc::attr::PlanIndexedPatchBasedBilateralParams &outParams, const boost::filesystem::path &refImgPath, const imaproc::attr::PlanIndexedPatchBasedBilateralParams &refParams, const ipReal64 imgCompareAbsTol, const ipReal64 imgCompareRelTol, const ipReal64 paramsCompareTol, const std::string &msgPrefix)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipBool, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipInt8, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipUInt8, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipInt16, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipUInt16, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipInt32, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipUInt32, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipInt64, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipUInt64, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipReal32, __m128)
 
 IPSDK_DATATYPE_TO_SSE2_MASK_TYPE (ipReal64, __m128d)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipBool, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipInt8, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipUInt8, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipInt16, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipUInt16, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipInt32, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipUInt32, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipInt64, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipUInt64, __m128i)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipReal32, __m128)
 
 IPSDK_DATATYPE_TO_SSE2_TYPE (ipReal64, __m128d)
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration2d (const ipReal32 scale)
 function allowing to create a geometric calibration 2d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration2d (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f)
 function allowing to create a geometric calibration 2d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration2d (const ipReal32 scale, const std::string &unitStr, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f)
 function allowing to create a geometric calibration 2d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration2d (const ipReal32 xScale, const ipReal32 yScale, const std::string &unitStr, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f)
 function allowing to create a geometric calibration 2d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration3d (const ipReal32 scale)
 function allowing to create a geometric calibration 3d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration3d (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 zOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f, const ipReal32 qk=0.f)
 function allowing to create a geometric calibration 3d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration3d (const ipReal32 scale, const std::string &unitStr, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 zOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f, const ipReal32 qk=0.f)
 function allowing to create a geometric calibration 3d
 
IPSDKBASEDATA_API GeometricCalibrationPtr createGeometricCalibration3d (const ipReal32 xScale, const ipReal32 yScale, const ipReal32 zScale, const std::string &unitStr, const ipReal32 xOrigin=0.f, const ipReal32 yOrigin=0.f, const ipReal32 zOrigin=0.f, const ipReal32 qr=0.f, const ipReal32 qi=0.f, const ipReal32 qj=0.f, const ipReal32 qk=0.f)
 function allowing to create a geometric calibration 3d
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipBool, eDIVT_Bool)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipInt8, eDIVT_Int8)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipUInt8, eDIVT_UInt8)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipInt16, eDIVT_Int16)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipUInt16, eDIVT_UInt16)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipInt32, eDIVT_Int32)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipUInt32, eDIVT_UInt32)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipInt64, eDIVT_Int64)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipUInt64, eDIVT_UInt64)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipReal32, eDIVT_Real32)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (ipReal64, eDIVT_Real64)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (std::string, eDIVT_String)
 
 IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT (boost::filesystem::path, eDIVT_Path)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipBool, eDIVT_Bool)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipInt8, eDIVT_Int8)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipUInt8, eDIVT_UInt8)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipInt16, eDIVT_Int16)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipUInt16, eDIVT_UInt16)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipInt32, eDIVT_Int32)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipUInt32, eDIVT_UInt32)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipInt64, eDIVT_Int64)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipUInt64, eDIVT_UInt64)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipReal32, eDIVT_Real32)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (ipReal64, eDIVT_Real64)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (std::string, eDIVT_String)
 
 IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE (boost::filesystem::path, eDIVT_Path)
 
IPSDKBASEDATA_API bool operator< (const OffsetXY &offset1, const OffsetXY &offset2)
 Comparison operators for offsets.
 
IPSDKBASEDATA_API bool operator== (const OffsetXY &offset1, const OffsetXY &offset2)
 Comparison operators for offsets.
 
IPSDKBASEDATA_API bool operator< (const OffsetXYZ &offset1, const OffsetXYZ &offset2)
 Comparison operators for offsets.
 
IPSDKBASEDATA_API bool operator== (const OffsetXYZ &offset1, const OffsetXYZ &offset2)
 Comparison operators for offsets.
 
IPSDKBASESHAPEANALYSIS_API ipsdk::BaseIArchiveoperator>> (ipsdk::BaseIArchive &ar, const ipsdk::SerializationIItem< ipsdk::shape::analysis::MeasureId > &item)
 serialization of ipsdk::shape::analysis::MeasureId structure
 
IPSDKBASESHAPEANALYSIS_API ipsdk::BaseOArchiveoperator<< (ipsdk::BaseOArchive &ar, const ipsdk::SerializationOItem< ipsdk::shape::analysis::MeasureId > &item)
 serialization of ipsdk::shape::analysis::MeasureId structure
 
IPSDKCOMM_API ipsdk::BaseIArchiveoperator>> (ipsdk::BaseIArchive &ar, const ipsdk::SerializationIItem< ipsdk::tcpip::Address > &item)
 serialization operators for Address type
 
IPSDKCOMM_API ipsdk::BaseOArchiveoperator<< (ipsdk::BaseOArchive &ar, const ipsdk::SerializationOItem< ipsdk::tcpip::Address > &item)
 serialization operators for Address type
 
IPSDKCORE_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< core::ExecResult > &item)
 serialization operators for eExecutionStatus enumerate More...
 
IPSDKCORE_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< core::ExecResult > &item)
 serialization operators for eExecutionStatus enumerate More...
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowSegment > &item)
 ipsdk::geom::RowSegment serialization operators
 
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::RowSegment > &item)
 ipsdk::geom::RowSegment serialization operators
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowIntersections > &item)
 ipsdk::geom::RowIntersections serialization operators
 
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::RowIntersections > &item)
 ipsdk::geom::RowIntersections serialization operators
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowSegment_UInt32 > &item)
 ipsdk::geom::RowSegment_UInt32 and RowIntersections_UInt32 serialization operators for version 1 (with UInt32 data)
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowIntersections_UInt32 > &item)
 ipsdk::geom::RowSegment_UInt32 and RowIntersections_UInt32 serialization operators for version 1 (with UInt32 data)
 
template<typename T >
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::Point2dData< T > > &item)
 ipsdk::geom::Point2dData serialization operators
 
template<typename T >
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::Point2dData< T > > &item)
 ipsdk::geom::Point2dData serialization operators
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowIntersections3d > &item)
 ipsdk::geom::RowIntersections3d serialization operators
 
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::RowIntersections3d > &item)
 ipsdk::geom::RowIntersections3d serialization operators
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::RowIntersections3d_UInt32 > &item)
 ipsdk::geom::RowIntersections3d_UInt32 serialization operators for version 1 (with UInt32 data)
 
template<typename T >
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::Point3dData< T > > &item)
 ipsdk::geom::Point3dData serialization operators
 
template<typename T >
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::Point3dData< T > > &item)
 ipsdk::geom::Point3dData serialization operators
 
IPSDKGEOMETRY_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::geom::BranchThicknessInfo > &item)
 Serialization operators for BranchThicknessInfo structure.
 
IPSDKGEOMETRY_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::geom::BranchThicknessInfo > &item)
 Serialization operators for BranchThicknessInfo structure.
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Vector > &item)
 ipsdk::math::Vector serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Vector > &item)
 ipsdk::math::Vector serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Vector2d > &item)
 ipsdk::math::Vector2d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Vector2d > &item)
 ipsdk::math::Vector2d serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Vector3d > &item)
 ipsdk::math::Vector3d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Vector3d > &item)
 ipsdk::math::Vector3d serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Vector4d > &item)
 ipsdk::math::Vector4d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Vector4d > &item)
 ipsdk::math::Vector4d serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Matrix > &item)
 ipsdk::math::Matrix serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Matrix > &item)
 ipsdk::math::Matrix serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Matrix2d > &item)
 ipsdk::math::Matrix2d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Matrix2d > &item)
 ipsdk::math::Matrix2d serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Matrix3d > &item)
 ipsdk::math::Matrix3d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Matrix3d > &item)
 ipsdk::math::Matrix3d serialization operators
 
IPSDKMATH_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipsdk::math::Matrix4d > &item)
 ipsdk::math::Matrix4d serialization operators
 
IPSDKMATH_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipsdk::math::Matrix4d > &item)
 ipsdk::math::Matrix4d serialization operators
 
IPSDKSERIALIZATION_API BoolResult writeToXmlFile (const boost::filesystem::path &filePath, const BaseSerializationObject &object)
 write a base serialization object to a xml file More...
 
IPSDKSERIALIZATION_API BoolResult writeToXmlFile (const boost::filesystem::path &filePath, const SerializationObjectConstPtr &pObject)
 write a base serialization object to a xml file More...
 
IPSDKSERIALIZATION_API BoolResult readFromXmlFile (const boost::filesystem::path &filePath, BaseSerializationObject &object)
 read a base serialization object from a xml file More...
 
IPSDKSERIALIZATION_API FileReadResult readFromXmlFile (const boost::filesystem::path &filePath)
 write a base serialization object to a xml file More...
 
IPSDKSERIALIZATION_API BoolResult writeToBinaryFile (const boost::filesystem::path &filePath, const BaseSerializationObject &object)
 write a base serialization object to a binary file More...
 
IPSDKSERIALIZATION_API BoolResult writeToBinaryFile (const boost::filesystem::path &filePath, const SerializationObjectConstPtr &pObject)
 write a base serialization object to a xml file More...
 
IPSDKSERIALIZATION_API BoolResult readFromBinaryFile (const boost::filesystem::path &filePath, BaseSerializationObject &object)
 read a base serialization object from a binary file More...
 
IPSDKSERIALIZATION_API FileReadResult readFromBinaryFile (const boost::filesystem::path &filePath)
 write a base serialization object to a xml file More...
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< BaseSerializationObject > &item)
 Serialization operators for objects.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< BaseSerializationObject > &item)
 Serialization operators for objects.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipBool > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipBool > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipInt8 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipInt8 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipUInt8 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipUInt8 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipInt16 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipInt16 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipUInt16 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipUInt16 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipInt32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipInt32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipUInt32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipUInt32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipInt64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipInt64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipUInt64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipUInt64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipReal32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipReal32 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< ipReal64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< ipReal64 > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::string > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::string > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< Guid > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< Guid > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< BoolResult > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< BoolResult > &item)
 Serialization operators for basic types.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::filesystem::path > &item)
 Path serialization operators.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::filesystem::path > &item)
 Path serialization operators.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::gregorian::date > &item)
 Date serialization operators.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::gregorian::date > &item)
 Date serialization operators.
 
IPSDKSERIALIZATION_API BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::posix_time::ptime > &item)
 Posix time serialization operators.
 
IPSDKSERIALIZATION_API BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::posix_time::ptime > &item)
 Posix time serialization operators.
 
template<class T >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::optional< T > > &item)
 boost::optional serialization operators
 
template<class T >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::optional< T > > &item)
 boost::optional serialization operators
 
template<class T >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::shared_ptr< T > > &item)
 shared_ptr serialization operators More...
 
template<class T >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::shared_ptr< T > > &item)
 shared_ptr serialization operators More...
 
template<BOOST_VARIANT_ENUM_PARAMS(class T) >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< boost::variant< BOOST_VARIANT_ENUM_PARAMS(T)> > &item)
 boost::variant serialization operators
 
template<BOOST_VARIANT_ENUM_PARAMS(class T) >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< boost::variant< BOOST_VARIANT_ENUM_PARAMS(T)> > &item)
 boost::variant serialization operators
 
template<typename T >
boost::enable_if_c< boost::mpl::and_< typename boost::is_base_of< ipsdk::BaseSerializationObject, T >::type, typename boost::mpl::not_< typename boost::is_same< ipsdk::BaseSerializationObject, T >::type >::type >::value, ipsdk::BaseIArchive & >::type operator>> (ipsdk::BaseIArchive &ar, const ipsdk::SerializationIItem< T > &item)
 template operators allowing to serialize objects deriving from BaseSerializationObject
 
template<typename T >
boost::enable_if_c< boost::mpl::and_< typename boost::is_base_of< ipsdk::BaseSerializationObject, T >::type, typename boost::mpl::not_< typename boost::is_same< ipsdk::BaseSerializationObject, T >::type >::type >::value, ipsdk::BaseOArchive & >::type operator<< (ipsdk::BaseOArchive &ar, const ipsdk::SerializationOItem< T > &item)
 template operators allowing to serialize objects deriving from BaseSerializationObject
 
template<class T >
boost::enable_if_c< boost::is_arithmetic< T >::value==false, BaseIArchive & >::type operator>> (BaseIArchive &ar, const SerializationIItem< std::vector< T > > &item)
 vector serialization operator
 
template<class T >
boost::enable_if_c< boost::is_arithmetic< T >::value==true &&boost::is_same< T, bool >::value==false, BaseIArchive & >::type operator>> (BaseIArchive &ar, const SerializationIItem< std::vector< T > > &item)
 vector serialization operator
 
template<class T >
boost::enable_if_c< boost::is_same< T, ipBool >::value==true, BaseIArchive & >::type operator>> (BaseIArchive &ar, const SerializationIItem< std::vector< T > > &item)
 vector serialization operator
 
template<class T >
boost::enable_if_c< boost::is_arithmetic< T >::value==false||boost::is_same< T, ipBool >::value==true, BaseOArchive & >::type operator<< (BaseOArchive &ar, const SerializationOItem< std::vector< T > > &item)
 vector serialization operator
 
template<class T >
boost::enable_if_c< boost::is_arithmetic< T >::value==true &&boost::is_same< T, ipBool >::value==false, BaseOArchive & >::type operator<< (BaseOArchive &ar, const SerializationOItem< std::vector< T > > &item)
 vector serialization operator
 
template<class T >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::list< T > > &item)
 list serialization operator
 
template<class T >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::list< T > > &item)
 list serialization operator
 
template<class Key , class Value >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::map< Key, Value > > &item)
 map serialization operator
 
template<class Key , class Value >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::map< Key, Value > > &item)
 map serialization operator
 
template<class T >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::set< T > > &item)
 set serialization operator
 
template<class T >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::set< T > > &item)
 set serialization operator
 
template<class T >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::deque< T > > &item)
 deque serialization operator
 
template<class T >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::deque< T > > &item)
 deque serialization operator
 
template<class T , class U >
BaseIArchiveoperator>> (BaseIArchive &ar, const SerializationIItem< std::pair< T, U > > &item)
 pair serialization operator
 
template<class T , class U >
BaseOArchiveoperator<< (BaseOArchive &ar, const SerializationOItem< std::pair< T, U > > &item)
 pair serialization operator
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipBool, eDT_Bool)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipInt8, eDT_Int8)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipUInt8, eDT_UInt8)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipInt16, eDT_Int16)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipUInt16, eDT_UInt16)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipInt32, eDT_Int32)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipUInt32, eDT_UInt32)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipInt64, eDT_Int64)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipUInt64, eDT_UInt64)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipReal32, eDT_Real32)
 
 IPSDK_DATATYPE_TO_ENUM_STRUCT (ipReal64, eDT_Real64)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipBool, eDT_Bool)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipInt8, eDT_Int8)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipUInt8, eDT_UInt8)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipInt16, eDT_Int16)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipUInt16, eDT_UInt16)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipInt32, eDT_Int32)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipUInt32, eDT_UInt32)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipInt64, eDT_Int64)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipUInt64, eDT_UInt64)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipReal32, eDT_Real32)
 
 IPSDK_ENUM_STRUCT_TO_DATATYPE (ipReal64, eDT_Real64)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Standard, eISAlignment::eISA_None)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Sse2, eISAlignment::eISA_16Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Sse3, eISAlignment::eISA_16Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Sse41, eISAlignment::eISA_16Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Sse42, eISAlignment::eISA_16Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Avx, eISAlignment::eISA_32Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Fma3, eISAlignment::eISA_32Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Avx2, eISAlignment::eISA_32Bytes)
 
 IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE (eInstructionSet::eIS_Avx512, eISAlignment::eISA_64Bytes)
 
 IPSDK_ALIGNMENT_TYPE_TO_SIZE (eISAlignment::eISA_None, 1)
 
 IPSDK_ALIGNMENT_TYPE_TO_SIZE (eISAlignment::eISA_8Bytes, 8)
 
 IPSDK_ALIGNMENT_TYPE_TO_SIZE (eISAlignment::eISA_16Bytes, 16)
 
 IPSDK_ALIGNMENT_TYPE_TO_SIZE (eISAlignment::eISA_32Bytes, 32)
 
 IPSDK_ALIGNMENT_TYPE_TO_SIZE (eISAlignment::eISA_64Bytes, 64)
 

Detailed Description

Main namespace for IPSDK library.

Author
H. Delestre

Enumeration Type Documentation

◆ eInstructionSetMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eInvalidInstructionSet 

Invalid instruction set enumerate value s.

eInvalidISAlignment 

Invalid instruction set alignment enumerate value s.

eTMinGreaterThanTMax 

Min is greater than max.

◆ eBufferType

Enumerate describing buffer types.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eBT_OwnTyped 

Own typed buffer.

eBT_OwnMutable 

Own mutable buffer.

eBT_Hybrid 

Hybrid buffer.

eBT_External 

External buffer.

eBT_FragHybrid 

Fragmented hybrid buffer.

◆ eCalibrationMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eInvalidScaleValue 

Scale value f should be strictly positive.

◆ eDataItemMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eInvalidDataItemTypeEnumValue 

Invalid data item type enumerate value s.

eInvalidDataItemValueTypeEnumValue 

Invalid data item value type enumerate value s.

eInvalidEnumIntValue 

Invalid enumerate integer value d for enumerate s.

eInvalidEnumStrValue 

Invalid enumerate string value s for enumerate s.

eInvalidNodeIndex 

Node with index d is out of bounds [0; d[.

eItemAlreadyExists 

Item with name s already exists into item map, can't insert it.

eItemDoesNotExist 

Item with name s does not exist into item map, can't remove it.

eNodeAlreadyRegistred 

Data item node s is already registred into factory, can't register more than once.

eNodeNameDoesNotExists 

Item with name s does not exists for current item node.

eNodeNotRegistredCanAccess 

Data item node s is not registred into factory, can't access data item node informations.

eNodeNotRegistredCanRemove 

Data item node s is not registred into factory, can't remove from factory.

eNullItemPtr 

Item shared pointer should not be null.

◆ eDataItemType

Enumerate describing data items type.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDIT_Leaf 

Leaf data item

eDIT_Node 

Data item used to store simple values.

Node data item

eDIT_LeafColl 

This is a complex data item agregating statically other data items - Size is variable but statically fixed

  • item types can be heterogeneous but statically fixed Collection of leafs data item
eDIT_NodeColl 

This is a data item agregating a collection of data items - Size is variable and dynamically fixed

  • item types must be homogeneous and statically fixed Collection of nodes data item
eDIT_Map 

This is a data item agregating a collection of data items - Size is variable and dynamically fixed

  • item types must be homogeneous and statically fixed Map data item

◆ eDataItemValueType

Enumerate describing data items value type.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDIVT_Bool 

Data item associated to a boolean value.

eDIVT_Int8 

Data item associated to a 8 bits signed integer value.

eDIVT_UInt8 

Data item associated to a 8 bits unsigned integer value.

eDIVT_Int16 

Data item associated to a 16 bits signed integer value.

eDIVT_UInt16 

Data item associated to a 16 bits unsigned integer value.

eDIVT_Int32 

Data item associated to a 32 bits signed integer value.

eDIVT_UInt32 

Data item associated to a 32 bits unsigned integer value.

eDIVT_Int64 

Data item associated to a 64 bits signed integer value.

eDIVT_UInt64 

Data item associated to a 64 bits unsigned integer value.

eDIVT_Real32 

Data item associated to a 32 bits real value.

eDIVT_Real64 

Data item associated to a 64 bits real value.

eDIVT_String 

Data item associated to a string value.

eDIVT_Path 

Data item associated to a path value.

eDIVT_Enum 

Data item associated to an enumerate value.

◆ eIOStatus

Enumerate describing data input/output status.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eIOS_Input 

Data has an input IO status.

eIOS_Output 

Data has an output IO status.

eIOS_InOut 

Data has an input and output IO status.

◆ eOptStatus

Enumerate describing data optional status.

optimization status

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eOS_Mandatory 

Data has a mandatory status.

eOS_Optional 

Data has an optional status.

◆ eDiscreteOrientation2d

Enumerate describing discrete orientation 2d.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDO2D_YMXM 

(-1, -1) orientation

eDO2D_YMX0 

( 0, -1) orientation

eDO2D_YMXP 

(+1, -1) orientation

eDO2D_Y0XM 

(-1, 0) orientation

eDO2D_Y0XP 

(+1, 0) orientation

eDO2D_YPXM 

(-1, +1) orientation

eDO2D_YPX0 

( 0, +1) orientation

eDO2D_YPXP 

(+1, +1) orientation

◆ eDiscreteOrientation3d

Enumerate describing discrete orientation 3d.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDO3D_ZMYMXM 

(-1, -1, -1) orientation

eDO3D_ZMYMX0 

( 0, -1, -1) orientation

eDO3D_ZMYMXP 

(+1, -1, -1) orientation

eDO3D_ZMY0XM 

(-1, 0, -1) orientation

eDO3D_ZMY0X0 

( 0, 0, -1) orientation

eDO3D_ZMY0XP 

(+1, 0, -1) orientation

eDO3D_ZMYPXM 

(-1, +1, -1) orientation

eDO3D_ZMYPX0 

( 0, +1, -1) orientation

eDO3D_ZMYPXP 

(+1, +1, -1) orientation

eDO3D_Z0YMXM 

(-1, -1, 0) orientation

eDO3D_Z0YMX0 

( 0, -1, 0) orientation

eDO3D_Z0YMXP 

(+1, -1, 0) orientation

eDO3D_Z0Y0XM 

(-1, 0, 0) orientation

eDO3D_Z0Y0XP 

(+1, 0, 0) orientation

eDO3D_Z0YPXM 

(-1, +1, 0) orientation

eDO3D_Z0YPX0 

( 0, +1, 0) orientation

eDO3D_Z0YPXP 

(+1, +1, 0) orientation

eDO3D_ZPYMXM 

(-1, -1, +1) orientation

eDO3D_ZPYMX0 

( 0, -1, +1) orientation

eDO3D_ZPYMXP 

(+1, -1, +1) orientation

eDO3D_ZPY0XM 

(-1, 0, +1) orientation

eDO3D_ZPY0X0 

( 0, 0, +1) orientation

eDO3D_ZPY0XP 

(+1, 0, +1) orientation

eDO3D_ZPYPXM 

(-1, +1, +1) orientation

eDO3D_ZPYPX0 

( 0, +1, +1) orientation

eDO3D_ZPYPXP 

(+1, +1, +1) orientation

◆ eIPSDKBaseDataMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eBufferAllocationFailed 

Memory allocation failed with requested size lld.

eBufferNotInitialized 

Buffer should be initialized before used.

eCantSetFragmentPtrOnOwn 

Can't set fragment data pointer on own fragment hybrid buffer.

eInvalidBufferType 

Invalid buffer type s.

eInvalidFragmentIndex 

Invalid fragment index d for buffer with d fragments.

eKeyAlreadyExists 

Key s already exists.

eUnknownKey 

Unknown key s.

◆ eKernelMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCantInsert 

Can't insert element into kernel, it already exists.

Can't insert element into structuring element, it already exists.

eCantReplace 

Can't replace element into kernel, it does not exists.

eCantRemove 

Can't remove element from kernel, it does not exists.

Can't remove element from structuring element, it does not exists.

eCantGetValue 

Can't get element value from kernel, it does not exists.

eInvalidGaussianCoverage 

Gaussian ratio and minimum kernel size can't be both null.

eInvalidGaussianRatio 

Invalid value f for input gaussian distribution ratio, should be in ]0, 1[.

eInvalidStdDevX 

Invalid value f for input standard deviation along x axis, should be in ]0, inf[.

eInvalidStdDevY 

Invalid value f for input standard deviation along y axis, should be in ]0, inf[.

eInvalidStdDevZ 

Invalid value f for input standard deviation along z axis, should be in ]0, inf[.

eKernelSizeMustBeOdd 

Input kernel size d must be odd.

eKernelXYSizeMismatch 

Provided half kernel size X d and Y d mismatch with value collection size d.

eKernelXYZSizeMismatch 

Provided half kernel size X d, Y d and Z d mismatch with value collection size d.

eSigmaXCloseToSigmaY 

Standard deviation along X and Y are close, the rotation may not be visible.

eNoKernelRotation2d 

The specified orientation is too low, the rotation is useless and the kernel won't be rotated.

◆ eStructuringElementMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCantInsert 

Can't insert element into kernel, it already exists.

Can't insert element into structuring element, it already exists.

eCantRemove 

Can't remove element from kernel, it does not exists.

Can't remove element from structuring element, it does not exists.

eInvalidRadius 

Invalid radius value f, should not be negative.

eSEInfoNotInit 

Structuring element informations have not been initialized.

eSEInfoInvalidSubType 

Structuring element sub type do not allows to retrieve this kind of information.

◆ ePlanIndexMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCantGetElement 

Can't get element for plan index z=d, c=d, t=d, element not found.

eCantInsertElement 

Can't insert element for plan index z=d, c=d, t=d, already exists.

eInvalidPlanOffset 

Plan offset d is not valid given plan indexed data with d plans.

eNullSharedPtr 

Null shared pointer for plan index z=d, c=d, t=d, can't insert it.

◆ eSklSrzMode

Enumerate describing serialization mode for objects with skeleton.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eSSM_Full 

serialization of all object data

eSSM_Skeleton 

serialization of skeleton of object

eSSM_Data 

serialization of object data (not part of skeleton)

◆ eIPSDKSerializationMessage

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eArchiveBadDataType 

Error while retrieving archive data on line d.

eArchiveDataReadError 

Error while reading serialization data from stream.

eArchiveDataReadErrorOnLine 

Archive contents error on line d.

eArchiveDataWriteError 

Error while writing serialization data to stream.

eBinaryCantReadFile 

Can't read object from binary file s.

eBinaryCantReadObject 

Can't read object of type s from binary file s.

eBinaryCantWrite 

Can't write object of type s to binary file s.

eBinaryCantWriteNullSharedPtr 

Can't write null shared pointer to binary file s.

eClassNameMismatch 

Error detected while reading object of type s, mismatch read class name s.

eClassReadDataError 

Error detected while reading object data of class s
s.

eClassReadDataException 

Exception detected while reading object data of class
s.

eClassVersionAlreadyRegistred 

Class version for class s is already registred, can't register more than once.

eClassVersionNotRegistred 

Class version for class s is not registred, can't get class version.

eClassWriteDataError 

Error detected while writing object data of class s
s.

eEndSubSectionError 

Error detected while ending sub section s
s.

eExceptionReadingBinaryFile 

Exception thrown while reading object from binary file s
s.

eExceptionReadingBinaryObject 

Exception thrown while reading object of type s from xml file s
s.

eExceptionReadingXmlFile 

Exception thrown while reading object from xml file s
s.

eExceptionReadingXmlObject 

Exception thrown while reading object of type s from xml file s
s.

eExceptionWritingBinary 

Exception thrown while writing object of type s to binary file s
s.

eExceptionWritingXml 

Exception thrown while writing object of type s to xml file s
s.

eInvalidArchiveFooter 

Invalid archive footer, archive may be corrupted.

eInvalidArchiveHeader 

Invalid archive header, not a valid archive for ipsdk.

eInvalidGuidSavedValue 

Invalid Guid saved value.

eInvalidObjectId 

Invalid object id, archive may be corrupted.

eInvalidReadClassVersion 

Read class version d for class s is greater than current class version d.

eInvalidSavedEnumString 

Invalid enumerate archive saved string s.

eInvalidSavedEnumValue 

Invalid enumerate archive saved value d.

eNullPtrAsRef 

Invalid object id, a reference should not be associated to nul pointer.

eSharedObjectAlreadyDeleted 

Shared object with id d has already been deleted, can't restore it from archive.

eVariantSrzError 

Try to load type with id d for type variant<s>, 'which' is out of type range.

eXmlCantReadFile 

Can't read object from xml file s.

eXmlCantReadObject 

Can't read object of type s from xml file s.

eXmlCantWrite 

Can't write object of type s to xml file s.

eXmlCantWriteNullSharedPtr 

Can't write null shared pointer to xml file s.

◆ eDataType

Enumerate describing a base type.

int types sized to pointer size regards to target platform

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDT_None 

undefined data type

eDT_Bool 

boolean data type

eDT_Int8 

signed 8 bits integer data type

eDT_UInt8 

unsigned 8 bits integer data type

eDT_Int16 

signed 16 bits integer data type

eDT_UInt16 

unsigned 16 bits integer data type

eDT_Int32 

signed 32 bits integer data type

eDT_UInt32 

unsigned 32 bits integer data type

eDT_Int64 

signed 64 bits integer data type

eDT_UInt64 

unsigned 64 bits integer data type

eDT_Real32 

32 bits real data type

eDT_Real64 

64 bits real data type

◆ eInstructionSet

Enumerate for processor instruction set description.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eIS_Standard 

compiler optimisations only

standard instruction set :

eIS_Sse2 

Streaming SIMD Extensions 2.

eIS_Sse3 

Streaming SIMD Extensions 3.

eIS_Sse41 

Streaming SIMD Extensions 4.1.

eIS_Sse42 

Streaming SIMD Extensions 4.2.

eIS_Avx 

Advanced Vector Extensions.

eIS_Fma3 

Fused multiply–add.

eIS_Avx2 

Advanced Vector Extensions 2.

eIS_Avx512 

(including fundation and byte and word instructions)

Advanced Vector Extensions 512

◆ eISAlignment

Enumerate describing memory data alignments.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eISA_None 

No alignment.

eISA_8Bytes 

8 bytes alignment

eISA_16Bytes 

16 bytes alignment

eISA_32Bytes 

32 bytes alignment

eISA_64Bytes 

64 bytes alignment

◆ eIPSDKUtilErrors

Enumerate describing messages.

Note
This enumerate is associated to a message map
See also
IPSDK_Message_Map
Enumerator
eCanFindCommonDataDirectory 

Can't find common data directory : s.

eCanFindUserDataDirectory 

Can't find user data directory : s.

eCanGetUserHome 

Can't retrieve user home directory from environment.

eCantCopyObject 

Class s is not copiable, can't copy object.

eCantCreateFile 

Can't create file s
s.

eClassAlreadyRegistred 

Class s is already registred into factory, can't register more than once.

eClassNotRegistredCantCreate 

Class s is not registred into factory, can't create class instance.

eClassNotRegistredCantRemove 

Class s is not registred into factory, can't remove class association.

eCmdExecutionFailed 

Execution of command [s] failed
s.

eFailedToCreateProcess 

Failed to create process with command line s
s.

eFailedToReadDataFromFile 

Failed to read data from file s.

eFailedToWriteDataToFile 

Failed to write data to file s.

eFileNotExists 

File s doesn't exists.

eFileReadAccess 

Can't open file s for read.

eInvalidPythonVersionFormat 

Invalid python executable retrieved format [s], expecting a string starting with something like [d].

eInvalidSDKStrProductInfoType 

Invalid enumerate value s for sdk product information string query.

eInvalidSDKVersionElementType 

Invalid enumerate value s for sdk version element query.

eInvalidSDKVersionStringType 

Invalid enumerate value s for sdk version string query.

eMsgFileInvalidContent 

Invalid content for message file s on line d.

eMsgFileInvalidId 

Invalid id value for message file s on line d.

eMsgIdAlreadyExists 

Message with id d for library s and enum type s already exists.

eMsgMsgIdAlreadyExists 

Message with id d for library s and enum type s already exists while processing message file s on line d.

eProcessTimeOut 

Process execution timeout after d milliseconds for command line s.

eProjectRootDirectoryNotSet 

Project root directory has not been set, can't get it.

eUnHandleEnumValue 

Unhandle enumerate value s.

eUnknownMsgId 

Unknown message id d for library s and enum type s.

eCouldNotOpenInputFileForCopy 

Could not open input file s for copy.

eCouldNotOpenOutputFileForCopy 

Could not open output file s for copy.

eCouldNotCopyFile 

Could not open file s for copy to s: s.

◆ eInternalDirectory

Enumerate describing IPSDK internal directories.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eID_Resources 

Resources root directory.

eID_Images 

Image sample root directory.

eID_Python 

Python root directory.

◆ eDefaultExternalDirectory

Enumerate describing IPSDK default external directories.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDED_Tmp 

Default temporary directory.

eDED_CommonConfig 

Default common (all users) configuration directory.

eDED_UserConfig 

Default user configuration directory.

eDED_MainLog 

Main log directory.

eDED_IdentityCheck1 

First identity directory (used for Free trial)

eDED_IdentityCheck2 

Second identity directory (used for Free trial)

◆ eDefaultInternalLibraryResourcePath

Enumerate describing default internal library resources path.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDILR_ProductLogo 

Library associated logo.

eDILR_CompanyLogo 

Company associated logo.

◆ eDefaultExternalLibraryResourcePath

Enumerate describing default external library resources path.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eDELR_CommonLicense 

Common (all user) license file.

eDELR_UserLicense 

User license file.

eDELR_CommonLocalProcessingPolicy 

Common (all user) local processing policy.

User local processing policy

eDELR_CommonDistributedProcessingPolicy 

Common (all user) distributed processing policy.

User distributed processing policy

eDELR_CommonNetworkConfiguration 

Common (all user) network configuration.

User network configuration

eDELR_InstallationLicense 

License file provided with an IPSDK installation.

◆ eSDKVersionElementType

Enumerate describing sdk version elements.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eSVET_FirstMajor 

First major version number for sdk.

eSVET_SecondMajor 

Second major version number for sdk.

eSVET_FirstMinor 

First minor version number for sdk.

eSVET_SecondMinor 

Second minor version number for sdk.

◆ eSDKStrVersionType

Enumerate describing sdk version string format.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eSSVT_Dot 

Version string with dot format : X.X.X.X.

eSSVT_Underscore 

Version string with underscore format : X_X_X_X.

◆ eSDKVersionStatus

Enumerate describing sdk version status.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eSVS_RTM 

Release To Manufacturing version (official version)

eSVS_Beta 

Beta version (non official)

◆ eSDKStrProductInfoType

Enumerate describing product information string format.

Note
This object is associated to a strong enumerate definition
See also
IPSDK_Enum
Enumerator
eSSPIT_ProductName 

Product name string with standard format.

eSSPIT_LongProductName 

Product name string with long format.

eSSPIT_CompanyName 

Company name string.

eSSPIT_Copyright 

Copyright associated to product.

Function Documentation

◆ getAlignmentType()

IPSDKUTIL_API eISAlignment ipsdk::getAlignmentType ( const eInstructionSet instructionSet)

function allowing to retrieve a memory data alignment type associated to an instruction set

◆ getAlignmentSize() [1/2]

IPSDKUTIL_API ipUInt8 ipsdk::getAlignmentSize ( const eInstructionSet instructionSet)

function allowing to retrieve a memory data alignment size associated to an instruction set

◆ getAlignmentSize() [2/2]

IPSDKUTIL_API ipUInt8 ipsdk::getAlignmentSize ( const eISAlignment alignmentType)

function allowing to retrieve a memory data alignment size associated to a memory data alignment type

◆ getNbEltsPerOp()

IPSDKUTIL_API ipUInt32 ipsdk::getNbEltsPerOp ( const eInstructionSet instructionSet)

function allowing to retrieve number of elements proceeded by operation for a given instruction set

◆ getMaxNbEltsPerOp()

IPSDKUTIL_API ipUInt32 ipsdk::getMaxNbEltsPerOp ( )

function allowing to retrieve maximum number of elements per operation among all possible instruction set

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [1/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipBool  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [2/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipInt8  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [3/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipUInt8  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [4/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipInt16  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [5/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipUInt16  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [6/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipInt32  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [7/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipUInt32  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [8/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipInt64  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [9/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipUInt64  ,
__m128i   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [10/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipReal32  ,
__m128   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_MASK_TYPE() [11/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_MASK_TYPE ( ipReal64  ,
__m128d   
)

Implementation of Sse2MaskType templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [1/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipBool  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [2/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipInt8  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [3/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipUInt8  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [4/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipInt16  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [5/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipUInt16  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [6/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipInt32  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [7/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipUInt32  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [8/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipInt64  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [9/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipUInt64  ,
__m128i   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [10/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipReal32  ,
__m128   
)

Implementation of Sse2Type templates

◆ IPSDK_DATATYPE_TO_SSE2_TYPE() [11/11]

ipsdk::IPSDK_DATATYPE_TO_SSE2_TYPE ( ipReal64  ,
__m128d   
)

Implementation of Sse2Type templates

◆ copyBufferMiror()

IPSDKBASEDATA_API void ipsdk::copyBufferMiror ( void *  pOutput,
const eDataType dataType,
const ipUInt64  size,
const void *  pInput 
)

copy of buffer mirroring data

Exceptions
ipsdk::IPSDKBaseDataExceptionif dataType == eDataType::eDT_None

◆ setBufferValues()

IPSDKBASEDATA_API void ipsdk::setBufferValues ( const ipReal64  value,
const eDataType dataType,
const ipUInt64  size,
void *  pBuf 
)

set buffer values to a given constant value

Exceptions
ipsdk::IPSDKBaseDataExceptionif dataType == eDataType::eDT_None

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [1/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipBool  ,
eDIVT_Bool   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [2/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipInt8  ,
eDIVT_Int8   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [3/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipUInt8  ,
eDIVT_UInt8   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [4/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipInt16  ,
eDIVT_Int16   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [5/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipUInt16  ,
eDIVT_UInt16   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [6/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipInt32  ,
eDIVT_Int32   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [7/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipUInt32  ,
eDIVT_UInt32   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [8/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipInt64  ,
eDIVT_Int64   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [9/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipUInt64  ,
eDIVT_UInt64   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [10/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipReal32  ,
eDIVT_Real32   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [11/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( ipReal64  ,
eDIVT_Real64   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [12/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( std::string  ,
eDIVT_String   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT() [13/13]

ipsdk::IPSDK_DATAITEM_VALUETYPE_TO_ENUM_STRUCT ( boost::filesystem::path  ,
eDIVT_Path   
)

Implementation of DataItemValueType2Enum templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [1/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipBool  ,
eDIVT_Bool   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [2/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipInt8  ,
eDIVT_Int8   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [3/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipUInt8  ,
eDIVT_UInt8   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [4/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipInt16  ,
eDIVT_Int16   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [5/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipUInt16  ,
eDIVT_UInt16   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [6/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipInt32  ,
eDIVT_Int32   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [7/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipUInt32  ,
eDIVT_UInt32   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [8/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipInt64  ,
eDIVT_Int64   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [9/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipUInt64  ,
eDIVT_UInt64   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [10/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipReal32  ,
eDIVT_Real32   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [11/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( ipReal64  ,
eDIVT_Real64   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [12/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( std::string  ,
eDIVT_String   
)

Implementation of Enum2DataItemValueType templates

◆ IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE() [13/13]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATAITEM_VALUETYPE ( boost::filesystem::path  ,
eDIVT_Path   
)

Implementation of Enum2DataItemValueType templates

◆ squareSEXY()

IPSDKBASEDATA_API StructuringElementXYPtr ipsdk::squareSEXY ( const ipUInt32  halfSESize)

function allowing to generate a square XY structuring element (SE)

Note
this structuring element will be composed of halfSESize*halfSESize elements

◆ rectangularSEXY()

IPSDKBASEDATA_API StructuringElementXYPtr ipsdk::rectangularSEXY ( const ipUInt32  halfSESizeX,
const ipUInt32  halfSESizeY 
)

function allowing to generate a rectangular XY structuring element (SE)

Note
this structuring element will be composed of halfSESizeX*halfSESizeY elements

◆ circularSEXY()

IPSDKBASEDATA_API StructuringElementXYPtr ipsdk::circularSEXY ( const ipReal64  radius)

function allowing to generate a filled circular XY structuring element (SE)

Note
this structuring element will be composed of all offsets $\left \{ (o_x, o_y) \right \} \in\mathbb{N}^2 / \left \| (o_x, o_y) \right \| \leq radius$
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ halfLinearSEXY()

IPSDKBASEDATA_API StructuringElementXYPtr ipsdk::halfLinearSEXY ( const ipReal64  theta,
const ipReal64  radius 
)

function allowing to generate a half linear structuring element (SE)

Note
Only direct half part of linear structuring element is considered (there is no symmetry around central offset)
Resulting structuring element will be associated to all offsets along given direction enclosed into circle defined by radius parameter
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ linearSEXY()

IPSDKBASEDATA_API StructuringElementXYPtr ipsdk::linearSEXY ( const ipReal64  theta,
const ipReal64  radius 
)

function allowing to generate a linear structuring element (SE)

Note
Resulting structuring element will be symmetric around central offset
Resulting structuring element will be associated to all offsets along given direction enclosed into circle defined by radius parameter
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ cubicSEXYZ()

IPSDKBASEDATA_API StructuringElementXYZPtr ipsdk::cubicSEXYZ ( const ipUInt32  halfSESize)

function allowing to generate a cubic XYZ structuring element (SE)

Note
this structuring element will be composed of halfSESize*halfSESize*halfSESize elements

◆ rectangularSEXYZ()

IPSDKBASEDATA_API StructuringElementXYZPtr ipsdk::rectangularSEXYZ ( const ipUInt32  halfSESizeX,
const ipUInt32  halfSESizeY,
const ipUInt32  halfSESizeZ 
)

function allowing to generate a rectangular parallelepiped XYZ structuring element (SE)

Note
this structuring element will be composed of halfSESizeX*halfSESizeY*halfSESizeZ elements

◆ sphericalSEXYZ()

IPSDKBASEDATA_API StructuringElementXYZPtr ipsdk::sphericalSEXYZ ( const ipReal64  radius)

function allowing to generate a filled spherical XYZ structuring element (SE)

Note
this structuring element will be composed of all offsets $\left \{ (o_x, o_y, o_z) \right \} \in\mathbb{N}^3 / \left \| (o_x, o_y, o_z) \right \| \leq radius$
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ halfLinearSEXYZ()

IPSDKBASEDATA_API StructuringElementXYZPtr ipsdk::halfLinearSEXYZ ( const ipReal64  theta,
const ipReal64  phi,
const ipReal64  radius 
)

function allowing to generate a half linear structuring element (SE)

Note
Only direct half part of linear structuring element is considered (there is no symmetry around central offset)
Resulting structuring element will be associated to all offsets along given direction enclosed into sphere defined by radius parameter
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ linearSEXYZ()

IPSDKBASEDATA_API StructuringElementXYZPtr ipsdk::linearSEXYZ ( const ipReal64  theta,
const ipReal64  phi,
const ipReal64  radius 
)

function allowing to generate a linear structuring element (SE)

Note
Resulting structuring element will be symmetric around central offset
Resulting structuring element will be associated to all offsets along given direction enclosed into sphere defined by radius parameter
Exceptions
ipsdk::IPSDKBaseDataExceptionif radius < 0

◆ operator>>() [1/2]

IPSDKCORE_API BaseIArchive& ipsdk::operator>> ( BaseIArchive ar,
const SerializationIItem< core::ExecResult > &  item 
)

serialization operators for eExecutionStatus enumerate

serialization operators for eExecutionResult enumerate serialization operators for ExecResult

◆ operator<<() [1/2]

IPSDKCORE_API BaseOArchive& ipsdk::operator<< ( BaseOArchive ar,
const SerializationOItem< core::ExecResult > &  item 
)

serialization operators for eExecutionStatus enumerate

serialization operators for eExecutionResult enumerate serialization operators for ExecResult

◆ writeToXmlFile() [1/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::writeToXmlFile ( const boost::filesystem::path &  filePath,
const BaseSerializationObject object 
)

write a base serialization object to a xml file

Returns
false in case of failure

◆ writeToXmlFile() [2/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::writeToXmlFile ( const boost::filesystem::path &  filePath,
const SerializationObjectConstPtr pObject 
)

write a base serialization object to a xml file

Returns
false in case of failure

◆ readFromXmlFile() [1/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::readFromXmlFile ( const boost::filesystem::path &  filePath,
BaseSerializationObject object 
)

read a base serialization object from a xml file

Returns
false in case of failure

◆ readFromXmlFile() [2/2]

IPSDKSERIALIZATION_API FileReadResult ipsdk::readFromXmlFile ( const boost::filesystem::path &  filePath)

write a base serialization object to a xml file

Returns
false in case of failure

◆ writeToBinaryFile() [1/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::writeToBinaryFile ( const boost::filesystem::path &  filePath,
const BaseSerializationObject object 
)

write a base serialization object to a binary file

Returns
false in case of failure

◆ writeToBinaryFile() [2/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::writeToBinaryFile ( const boost::filesystem::path &  filePath,
const SerializationObjectConstPtr pObject 
)

write a base serialization object to a xml file

Returns
false in case of failure

◆ readFromBinaryFile() [1/2]

IPSDKSERIALIZATION_API BoolResult ipsdk::readFromBinaryFile ( const boost::filesystem::path &  filePath,
BaseSerializationObject object 
)

read a base serialization object from a binary file

Returns
false in case of failure

◆ readFromBinaryFile() [2/2]

IPSDKSERIALIZATION_API FileReadResult ipsdk::readFromBinaryFile ( const boost::filesystem::path &  filePath)

write a base serialization object to a xml file

Returns
false in case of failure

◆ operator>>() [2/2]

template<class T >
BaseIArchive& ipsdk::operator>> ( BaseIArchive ar,
const SerializationIItem< boost::shared_ptr< T > > &  item 
)

shared_ptr serialization operators

Only for objects derived from BaseSerializationObject

◆ operator<<() [2/2]

template<class T >
BaseOArchive& ipsdk::operator<< ( BaseOArchive ar,
const SerializationOItem< boost::shared_ptr< T > > &  item 
)

shared_ptr serialization operators

Only for objects derived from BaseSerializationObject

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [1/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipBool  ,
eDT_Bool   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [2/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipInt8  ,
eDT_Int8   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [3/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipUInt8  ,
eDT_UInt8   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [4/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipInt16  ,
eDT_Int16   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [5/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipUInt16  ,
eDT_UInt16   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [6/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipInt32  ,
eDT_Int32   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [7/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipUInt32  ,
eDT_UInt32   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [8/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipInt64  ,
eDT_Int64   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [9/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipUInt64  ,
eDT_UInt64   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [10/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipReal32  ,
eDT_Real32   
)

Implementation of DataType2Enum templates

◆ IPSDK_DATATYPE_TO_ENUM_STRUCT() [11/11]

ipsdk::IPSDK_DATATYPE_TO_ENUM_STRUCT ( ipReal64  ,
eDT_Real64   
)

Implementation of DataType2Enum templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [1/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipBool  ,
eDT_Bool   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [2/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipInt8  ,
eDT_Int8   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [3/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipUInt8  ,
eDT_UInt8   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [4/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipInt16  ,
eDT_Int16   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [5/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipUInt16  ,
eDT_UInt16   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [6/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipInt32  ,
eDT_Int32   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [7/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipUInt32  ,
eDT_UInt32   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [8/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipInt64  ,
eDT_Int64   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [9/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipUInt64  ,
eDT_UInt64   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [10/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipReal32  ,
eDT_Real32   
)

Implementation of Enum2DataType templates

◆ IPSDK_ENUM_STRUCT_TO_DATATYPE() [11/11]

ipsdk::IPSDK_ENUM_STRUCT_TO_DATATYPE ( ipReal64  ,
eDT_Real64   
)

Implementation of Enum2DataType templates

◆ copyDynamicObjectPtr() [1/2]

template<typename T >
void ipsdk::copyDynamicObjectPtr ( const boost::scoped_ptr< T > &  pInput,
boost::scoped_ptr< T > &  pOutput 
)

copy of scoped pointer to BaseDynamicObject derived type

A reallocation and a copy of resource is done if needed (if input pointer is not null)

◆ copyDynamicObjectPtr() [2/2]

template<typename T >
void ipsdk::copyDynamicObjectPtr ( const boost::shared_ptr< T > &  pInput,
boost::shared_ptr< T > &  pOutput 
)

copy of shared pointer to BaseDynamicObject derived type

A reallocation and a copy of resource is done if needed (if input pointer is not null)

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [1/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Standard  ,
eISAlignment::eISA_None   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [2/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Sse2  ,
eISAlignment::eISA_16Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [3/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Sse3  ,
eISAlignment::eISA_16Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [4/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Sse41  ,
eISAlignment::eISA_16Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [5/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Sse42  ,
eISAlignment::eISA_16Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [6/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Avx  ,
eISAlignment::eISA_32Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [7/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Fma3  ,
eISAlignment::eISA_32Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [8/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Avx2  ,
eISAlignment::eISA_32Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE() [9/9]

ipsdk::IPSDK_INSTRUCTIONSET_TO_ALIGNMENT_TYPE ( eInstructionSet::eIS_Avx512  ,
eISAlignment::eISA_64Bytes   
)

Implementation of ISAlignmentType templates

◆ IPSDK_ALIGNMENT_TYPE_TO_SIZE() [1/5]

ipsdk::IPSDK_ALIGNMENT_TYPE_TO_SIZE ( eISAlignment::eISA_None  ,
 
)

Implementation of ISAlignmentSize templates

◆ IPSDK_ALIGNMENT_TYPE_TO_SIZE() [2/5]

ipsdk::IPSDK_ALIGNMENT_TYPE_TO_SIZE ( eISAlignment::eISA_8Bytes  ,
 
)

Implementation of ISAlignmentSize templates

◆ IPSDK_ALIGNMENT_TYPE_TO_SIZE() [3/5]

ipsdk::IPSDK_ALIGNMENT_TYPE_TO_SIZE ( eISAlignment::eISA_16Bytes  ,
16   
)

Implementation of ISAlignmentSize templates

◆ IPSDK_ALIGNMENT_TYPE_TO_SIZE() [4/5]

ipsdk::IPSDK_ALIGNMENT_TYPE_TO_SIZE ( eISAlignment::eISA_32Bytes  ,
32   
)

Implementation of ISAlignmentSize templates

◆ IPSDK_ALIGNMENT_TYPE_TO_SIZE() [5/5]

ipsdk::IPSDK_ALIGNMENT_TYPE_TO_SIZE ( eISAlignment::eISA_64Bytes  ,
64   
)

Implementation of ISAlignmentSize templates

◆ getFormatedTime()

IPSDKUTIL_API std::string ipsdk::getFormatedTime ( )

function allowing to retrieve formatted date and time string

On output date and time are formatted with format : Year-Month-Day_Hours-Minutes-Seconds

◆ getProjectRootDirectory()

IPSDKUTIL_API const boost::filesystem::path& ipsdk::getProjectRootDirectory ( )

function allowing to retrieve project root directory

Exceptions
ipsdk::IPSDKUtilExceptionif isSetProjectRootDirectory() == false

◆ getSubDirectory()

IPSDKUTIL_API boost::filesystem::path ipsdk::getSubDirectory ( const eInternalDirectory dirId)

retrieve relative subdirectory associated to a given id

Exceptions
ipsdk::IPSDKUtilExceptionif failed to retrieve directory

◆ getIPSDKDefaultDirectory()

IPSDKUTIL_API boost::filesystem::path ipsdk::getIPSDKDefaultDirectory ( const eDefaultExternalDirectory dirId)

retrieve ipsdk default external directory

Exceptions
ipsdk::IPSDKUtilExceptionif failed to retrieve directory

◆ getRelativePath()

IPSDKUTIL_API boost::filesystem::path ipsdk::getRelativePath ( const boost::filesystem::path &  fromPath,
const boost::filesystem::path &  toPath 
)

Retrieve relative path allowing to pass from fromPath to toPass : toPath = fromPath / getRelativePath(fromPath, toPath)

◆ getRelativeFromRoot()

IPSDKUTIL_API boost::filesystem::path ipsdk::getRelativeFromRoot ( const boost::filesystem::path &  rootPath,
const boost::filesystem::path &  subPath 
)

Retrieve relative of a sub directory path from a root path subPath = rootPath / getRelativeFromRoot(rootPath, subPath)

Note
if subPath is not a sub directory of rootPath function returns an empty path

◆ getPythonRootDir()

IPSDKUTIL_API boost::filesystem::path ipsdk::getPythonRootDir ( const ipUInt32  pythonMajorVersion,
const ipUInt32  pythonMinorVersion 
)

function allowing to retrieve path to python executable for a given version from environment if it exits

Returns
an empty path if not found

◆ getPythonExecPathFromEnvVar()

IPSDKUTIL_API boost::filesystem::path ipsdk::getPythonExecPathFromEnvVar ( const ipUInt32  pythonMajorVersion,
const ipUInt32  pythonMinorVersion 
)

function allowing to retrieve python executable path from environment variable associated to a given python version

Returns
an empty path if not found

◆ getPythonExecVersion()

IPSDKUTIL_API BoolResult ipsdk::getPythonExecVersion ( const boost::filesystem::path &  pythonExecPath,
ipUInt32 majorVersion,
ipUInt32 minorVersion,
ipUInt32 microVersion 
)

function allowing to retrieve python executable version

Returns
false in case of failure

◆ getSDKVersionElement()

IPSDKUTIL_API ipUInt32 ipsdk::getSDKVersionElement ( const eSDKVersionElementType sdkVersionElementType)

retrieve version element for sdk

Exceptions
ipsdk::IPSDKUtilExceptionif sdkVersionElementType is invalid

◆ getSDKStrVersion()

IPSDKUTIL_API const std::string& ipsdk::getSDKStrVersion ( const eSDKStrVersionType sdkStrVersionType)

retrieve string formated version for sdk

Exceptions
ipsdk::IPSDKUtilExceptionif sdkStrVersionType is invalid

◆ getSDKProductInfo()

IPSDKUTIL_API const std::string& ipsdk::getSDKProductInfo ( const eSDKStrProductInfoType sdkStrProductInfoType)

retrieve string informations about product

Exceptions
ipsdk::IPSDKUtilExceptionif sdkStrProductInfoType is invalid

◆ readLine()

IPSDKUTIL_API void ipsdk::readLine ( std::istream &  is,
std::string &  strLine 
)

function allowing to read a line from a stream

This function comes in replacement of getline function. It allowes to handle multiplatform end of line

Warning
Empty lines are ignored by this function

◆ copyFile()

IPSDKUTIL_API int ipsdk::copyFile ( const boost::filesystem::path &  inPath,
const boost::filesystem::path &  outPath 
)

function allowing to copy a file

This function comes in replacement of boost::filesystem::copy_file function. and replace the output file if it already exists It allowes to handle multiplatform file systems

◆ getHostName()

IPSDKUTIL_API std::string ipsdk::getHostName ( )

retrieve local host name

Returns
an empty string on failure

◆ loadLibrary()

IPSDKUTIL_API BoolResult ipsdk::loadLibrary ( const boost::filesystem::path &  filePath)

load library given its path

Returns
false in case of failure

◆ addLibraryDirectory()

IPSDKUTIL_API BoolResult ipsdk::addLibraryDirectory ( const boost::filesystem::path &  dirPath)

add a library directory for library delay load search

Returns
false in case of failure

◆ getPlatformName()

IPSDKUTIL_API std::string ipsdk::getPlatformName ( )

retrieve platform name

Returns
string such as "Windows" for Windows compilation

◆ is64BitsConfig()

IPSDKUTIL_API bool ipsdk::is64BitsConfig ( )

retrieve x64 flag

Returns
true if 64 bits configuration

◆ isDebugConfig()

IPSDKUTIL_API bool ipsdk::isDebugConfig ( )

retrieve debug flag

Returns
true if debug configuration

◆ getFullPlatformName()

IPSDKUTIL_API std::string ipsdk::getFullPlatformName ( )

retrieve full platform name

Returns
string such as "Windows 64 bits release"

◆ getOSName()

IPSDKUTIL_API std::string ipsdk::getOSName ( )

retrieve full operating system name

Returns
string such as : "Microsoft Windows 7 Professional Service Pack 1 (build 7601), 64-bit"

◆ displayHtml()

IPSDKUTIL_API BoolResult ipsdk::displayHtml ( const boost::filesystem::path &  filePath)

display html file through default browser

Returns
false in case of error

◆ getApplicationPath()

IPSDKUTIL_API BoolResult ipsdk::getApplicationPath ( boost::filesystem::path &  appPath)

retrieve application path

Returns
false in case of error

◆ getApplicationDir()

IPSDKUTIL_API BoolResult ipsdk::getApplicationDir ( boost::filesystem::path &  appDir)

retrieve application directory

Returns
false in case of error

◆ getApplicationName()

IPSDKUTIL_API BoolResult ipsdk::getApplicationName ( std::string &  appName)

retrieve application name

Returns
false in case of error

◆ getUserRootDataDir()

IPSDKUTIL_API BoolResult ipsdk::getUserRootDataDir ( boost::filesystem::path &  dataPath)

retrieve root user data directory

Returns
false in case of error

◆ getCommonRootDataDir()

IPSDKUTIL_API BoolResult ipsdk::getCommonRootDataDir ( boost::filesystem::path &  dataPath)

retrieve root common (all users) data directory

Returns
false in case of error

◆ getUserLibraryDataDir()

IPSDKUTIL_API BoolResult ipsdk::getUserLibraryDataDir ( boost::filesystem::path &  dataPath)

retrieve library user data directory

Returns
false in case of error

◆ getCommonLibraryDataDir()

IPSDKUTIL_API BoolResult ipsdk::getCommonLibraryDataDir ( boost::filesystem::path &  dataPath)

retrieve library common data directory

Returns
false in case of error

◆ setThreadName()

IPSDKUTIL_API void ipsdk::setThreadName ( const std::string &  threadName)

function allowing to set current thread name for debugging purpose

Remarks
this function only work under Windows and has no effect on other platforms

◆ createProcess() [1/2]

IPSDKUTIL_API BoolResult ipsdk::createProcess ( const boost::filesystem::path &  execPath,
const std::string &  cmdArgs,
const ipUInt32  timeout,
ipInt32 exitCode 
)

Function allowing to create a process

Parameters
[in]execPathfull path to executable
[in]cmdArgscommand line arguments for execution
[in]timeoutTime out for execution duration.
A value of -1 stands for infinite wait.
[out]exitCodeexit code associated to process execution
Returns
false in case of failure

◆ createProcess() [2/2]

IPSDKUTIL_API BoolResult ipsdk::createProcess ( const boost::filesystem::path &  execPath,
const std::string &  cmdArgs,
std::string &  stdOutStr 
)

Function allowing to create a process and to retrieve standard output results into a string

Parameters
[in]execPathfull path to executable
[in]cmdArgscommand line arguments for execution
[out]standardoutput string data
Warning
beware of size of standard output stored into output string
Returns
false in case of failure

◆ getPythonAvailableVersions()

IPSDKUTIL_API std::vector<std::pair<ipUInt32, ipUInt32> > ipsdk::getPythonAvailableVersions ( )

retrieve available versions for python library

Returns
a collection of pairs of unsigned integers. First integer stands for major python version, second one for minor version