OTB  9.0.0
Orfeo Toolbox
otbRAMDrivenStrippedStreamingManager.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 #ifndef otbRAMDrivenStrippedStreamingManager_h
22 #define otbRAMDrivenStrippedStreamingManager_h
23 
24 #include "itkImageRegionSplitter.h"
25 #include "otbStreamingManager.h"
26 
27 namespace otb
28 {
29 
43 template <class TImage>
44 class ITK_EXPORT RAMDrivenStrippedStreamingManager : public StreamingManager<TImage>
45 {
46 public:
50  typedef itk::SmartPointer<Self> Pointer;
51  typedef itk::SmartPointer<const Self> ConstPointer;
52 
53  typedef TImage ImageType;
55 
57  itkNewMacro(Self);
58 
60  itkTypeMacro(RAMDrivenStrippedStreamingManager, itk::LightObject);
61 
63  itkStaticConstMacro(ImageDimension, unsigned int, ImageType::ImageDimension);
64 
67  itkSetMacro(AvailableRAMInMB, unsigned int);
68 
71  itkGetConstMacro(AvailableRAMInMB, unsigned int);
72 
74  itkSetMacro(Bias, double);
75 
77  itkGetConstMacro(Bias, double);
78 
81  void PrepareStreaming(itk::DataObject* input, const RegionType& region) override;
82 
83 protected:
86 
88  typedef itk::ImageRegionSplitter<itkGetStaticConstMacro(ImageDimension)> SplitterType;
89 
91  unsigned int m_AvailableRAMInMB;
92 
94  double m_Bias;
95 
96 private:
98  void operator=(const RAMDrivenStrippedStreamingManager&);
99 };
100 
101 } // End namespace otb
102 
103 #ifndef OTB_MANUAL_INSTANTIATION
105 #endif
106 
107 #endif
otb::RAMDrivenStrippedStreamingManager::m_Bias
double m_Bias
Definition: otbRAMDrivenStrippedStreamingManager.h:94
otb::StreamingManager
This class handles the streaming process used in the writers implementation.
Definition: otbStreamingManager.h:53
otb::RAMDrivenStrippedStreamingManager::Self
RAMDrivenStrippedStreamingManager Self
Definition: otbRAMDrivenStrippedStreamingManager.h:48
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otbRAMDrivenStrippedStreamingManager.hxx
otb::RAMDrivenStrippedStreamingManager::Superclass
StreamingManager< TImage > Superclass
Definition: otbRAMDrivenStrippedStreamingManager.h:49
otb::RAMDrivenStrippedStreamingManager::RegionType
Superclass::RegionType RegionType
Definition: otbRAMDrivenStrippedStreamingManager.h:54
otb::RAMDrivenStrippedStreamingManager
This class computes the divisions needed to stream an image by strips, according to a user-defined av...
Definition: otbRAMDrivenStrippedStreamingManager.h:44
otb::RAMDrivenStrippedStreamingManager::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbRAMDrivenStrippedStreamingManager.h:50
otb::RAMDrivenStrippedStreamingManager::m_AvailableRAMInMB
unsigned int m_AvailableRAMInMB
Definition: otbRAMDrivenStrippedStreamingManager.h:91
otb::RAMDrivenStrippedStreamingManager::SplitterType
itk::ImageRegionSplitter< itkGetStaticConstMacro(ImageDimension)> SplitterType
Definition: otbRAMDrivenStrippedStreamingManager.h:88
otbStreamingManager.h
otb::RAMDrivenStrippedStreamingManager::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbRAMDrivenStrippedStreamingManager.h:51
otb::RAMDrivenStrippedStreamingManager::ImageType
TImage ImageType
Definition: otbRAMDrivenStrippedStreamingManager.h:53
otb::StreamingManager::RegionType
ImageType::RegionType RegionType
Definition: otbStreamingManager.h:64