IPSDK  4_1_0_2
IPSDK : Image Processing Software Development Kit
InOutImageZStrip3d.h
1 // InOutImageZStrip3d.h:
3 // ---------------------
4 //
14 
15 #ifndef __IPSDKIMAGE_INOUTIMAGEZSTRIP3D_H__
16 #define __IPSDKIMAGE_INOUTIMAGEZSTRIP3D_H__
17 
18 #include <IPSDKImage/Fragment/Strip/ZStrip3d/BaseImageZStrip3d.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 PlanStorageColl1d InputStorageType;
44 
45 public:
51 
52 // methods
53 public:
54  //-----------------------------------
57  //-----------------------------------
58 
65  BoolResult readFromImage() const;
66 
75  BoolResult writeToImage();
77 
83  HybridBuffer& getBuffer(const ipUInt64 zPlanIdx);
84 
85 protected:
93  void init(const ipUInt64 cPlanIdx,
94  const ipUInt64 tPlanIdx,
95  const ipUInt64 stripStartOffsetZ,
96  const ipUInt64 stripSizeZ,
97  const ipUInt64 imageSizeZ,
98  const eStripAllocationType& stripAllocationType,
99  const eStripParsingDirection& stripParsingDirection,
100  const PlanStorageColl1d& volumeColl,
101  const DataIdentifierConstPtr& pImageIdentifier,
102  const DataItemMapConstPtr& pImageHeader);
103 
105  void createSubStrip(const ipUInt64 zPlanIdx,
106  const ipUInt64 cPlanIdx,
107  const ipUInt64 tPlanIdx,
108  const eStripAllocationType& stripAllocationType,
109  const eStripParsingDirection& stripParsingDirection,
110  const PlanStoragePtr& pPlanStorage,
111  const DataIdentifierConstPtr& pImageIdentifier,
112  const DataItemMapConstPtr& pImageHeader,
113  ImageYStrip2dPtr& pImageYStrip2d) const;
114 
115 // attributes
116 protected:
117 
118 };
119 
122 
123 inline HybridBuffer&
125 {
126  return accessBuffer(zPlanIdx);
127 }
128 
131 
132 } // end of namespace image
133 } // end of namespace ipsdk
134 
135 #endif // __IPSDKIMAGE_INOUTIMAGEZSTRIP3D_H__
Main namespace for IPSDK library.
Definition: AlgorithmFunctionEfficiency.h:22
uint64_t ipUInt64
Base types definition.
Definition: BaseTypes.h:55
#define IPSDK_DECLARE_INOUT_DATA()
macro allowing to declare an in/out data
Definition: DataStatusHdrMacros.h:120
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
Base class for image 3d strip with splitting along Z axis.
Definition: BaseImageZStrip3d.h:34
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
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
const HybridBuffer & accessBuffer(const ipUInt64 zPlanIdx) const
access to strip full buffer
HybridBuffer & getBuffer(const ipUInt64 zPlanIdx)
retrieve strip full buffer
Definition: InOutImageZStrip3d.h:124
Class allowing to encapsulate an hybrid form of buffer.
Definition: HybridBuffer.h:52
std::vector< PlanStoragePtr > PlanStorageColl1d
Definition: ImageTypes.h:184
Base class for images data type.
Definition: BaseImage.h:43
boost::shared_ptr< BaseImageYStrip2d > ImageYStrip2dPtr
Definition: ImageStripTypes.h:117
Input and output class for image 3d strip with splitting along Z axis.
Definition: InOutImageZStrip3d.h:26