IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
InOutImageXStrip2d.h
1 // InOutImageXStrip2d.h:
3 // ---------------------
4 //
14 
15 #ifndef __IPSDKIMAGE_INOUTIMAGEXSTRIP2D_H__
16 #define __IPSDKIMAGE_INOUTIMAGEXSTRIP2D_H__
17 
18 #include <IPSDKImage/Fragment/Strip/XStrip2d/BaseImageXStrip2d.h>
19 
20 namespace ipsdk {
21 namespace image {
22 
25 
27 {
28  // declare serial class
30 
31  // declare in/out data
33 
34  // friend class for protected members access
35  friend struct ImageStripExtractor;
36 
37 // predefined public types
38 public:
39  // Image support type
40  typedef BaseImage ImageType;
41 
42  // Input storage type associated to strip
43  typedef PlanStoragePtr InputStorageType;
44 
45 public:
51 
52 // methods
53 public:
54  //-----------------------------------
57  //-----------------------------------
58 
65  BoolResult readFromImage() const;
66 
75  BoolResult writeToImage();
77 
81  FragHybridBuffer& getBuffer();
82 
83 protected:
87  void init(const ipUInt64 zPlanIdx,
88  const ipUInt64 cPlanIdx,
89  const ipUInt64 tPlanIdx,
90  const ipUInt64 stripStartOffsetX,
91  const ipUInt64 stripSizeX,
92  const eStripAllocationType& stripAllocationType,
93  const eStripParsingDirection& stripParsingDirection,
94  const PlanStoragePtr& pPlanStorage,
95  const DataIdentifierConstPtr& pImageIdentifier,
96  const DataItemMapConstPtr& pImageHeader);
97 
98 // attributes
99 protected:
100 
101 };
102 
105 
106 inline FragHybridBuffer&
108 {
109  return accessBuffer();
110 }
111 
114 
115 } // end of namespace image
116 } // end of namespace ipsdk
117 
118 #endif // __IPSDKIMAGE_INOUTIMAGEXSTRIP2D_H__
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22
uint64_t ipUInt64
Base types definition.
Definition: BaseTypes.h:55
const FragHybridBuffer & accessBuffer() const
access to strip full buffer
#define IPSDK_DECLARE_INOUT_DATA()
macro allowing to declare an in/out data
Definition: DataStatusHdrMacros.h:120
Class allowing to encapsulate an hybrid form of fragment buffer.
Definition: FragHybridBuffer.h:53
eStripAllocationType
Enumerate describing image strip allocation policy.
Definition: ImageStripTypes.h:88
#define IPSDK_DECLARE_SERIAL_WITHOUT_COPY(libraryName, className)
macro enabling serialization on class
Definition: SerializationHdrMacro.h:79
Structure used to extract image strips from an image.
Definition: ImageStripExtractor.h:31
boost::shared_ptr< const DataItemMap > DataItemMapConstPtr
shared pointer to const DataItemMap
Definition: DataItemTypes.h:170
#define IPSDKIMAGE_API
Import/Export macro for library IPSDKImage.
Definition: IPSDKImageExports.h:27
Input and output class for image 2d strip with splitting along X axis.
Definition: InOutImageXStrip2d.h:26
boost::shared_ptr< BasePlanStorage > PlanStoragePtr
shared pointer to image plan storage
Definition: PlanStorageTypes.h:55
eStripParsingDirection
Enumerate describing strip parsing direction.
Definition: ImageStripTypes.h:72
boost::shared_ptr< const DataIdentifier > DataIdentifierConstPtr
shared pointer to const data identifier
Definition: DataIdentifierTypes.h:31
Base class for images data type.
Definition: BaseImage.h:43
Base class for image 2d strip with splitting along X axis.
Definition: BaseImageXStrip2d.h:34
FragHybridBuffer & getBuffer()
retrieve strip full buffer
Definition: InOutImageXStrip2d.h:107