ITK  5.4.0
Insight Toolkit
itkMemoryProbe.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * https://www.apache.org/licenses/LICENSE-2.0.txt
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *=========================================================================*/
18 #ifndef itkMemoryProbe_h
19 #define itkMemoryProbe_h
20 
21 #include "itkResourceProbe.h"
22 #include "itkMemoryUsageObserver.h"
23 #include "itkIntTypes.h"
24 
25 namespace itk
26 {
39 class ITKCommon_EXPORT MemoryProbe : public ResourceProbe<OffsetValueType, double>
40 {
41 public:
42  MemoryProbe();
43  ~MemoryProbe() override;
44 
47 
49  using MeanMemoryLoadType = double;
50 
51 protected:
53  GetInstantValue() const override;
54 
55 private:
56  mutable MemoryUsageObserver m_MemoryObserver{};
57 };
58 } // end namespace itk
59 
60 #endif // itkMemoryProbe_h
itk::MemoryProbe
Computes the memory allocated between two points in code.
Definition: itkMemoryProbe.h:39
itk::ResourceProbe
Computes the change of a value between two points in code.
Definition: itkResourceProbe.h:45
itk::MemoryProbe::MemoryLoadType
OffsetValueType MemoryLoadType
Definition: itkMemoryProbe.h:46
itk::MemoryUsageObserver
Provides the memory usage of the process.
Definition: itkMemoryUsageObserver.h:155
itkResourceProbe.h
itk::OffsetValueType
long OffsetValueType
Definition: itkIntTypes.h:94
itkIntTypes.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itkMemoryUsageObserver.h
itk::MemoryProbe::MeanMemoryLoadType
double MeanMemoryLoadType
Definition: itkMemoryProbe.h:49