1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
|
/*=========================================================================
*
* Copyright NumFOCUS
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0.txt
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*=========================================================================*/
#ifndef itkMemoryProbe_h
#define itkMemoryProbe_h
#include "itkResourceProbe.h"
#include "itkMemoryUsageObserver.h"
#include "itkIntTypes.h"
namespace itk
{
/** \class MemoryProbe
*
* \brief Computes the memory allocated between two points in code.
*
* This class allows the user to trace the memory charge between the execution
* of two pieces of code. It can be started and stopped in order to evaluate
* the execution over multiple passes. The values of memory are taken from
* GetProcessMemoryInfo() for Windows, the SMAPS file for Linux
* and getrusage() otherwise.
*
* \ingroup ITKCommon
*/
class ITKCommon_EXPORT MemoryProbe : public ResourceProbe<OffsetValueType, double>
{
public:
MemoryProbe();
~MemoryProbe() override;
/** Type for measuring memory. */
using MemoryLoadType = OffsetValueType;
/** Type for measuring the average memory. */
using MeanMemoryLoadType = double;
protected:
MemoryLoadType
GetInstantValue() const override;
private:
mutable MemoryUsageObserver m_MemoryObserver{};
};
} // end namespace itk
#endif // itkMemoryProbe_h
|
