File: itkProgressTransformer.h

package info (click to toggle)
insighttoolkit5 5.4.3-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 704,384 kB
  • sloc: cpp: 783,592; ansic: 628,724; xml: 44,704; fortran: 34,250; python: 22,874; sh: 4,078; pascal: 2,636; lisp: 2,158; makefile: 464; yacc: 328; asm: 205; perl: 203; lex: 146; tcl: 132; javascript: 98; csh: 81
file content (73 lines) | stat: -rw-r--r-- 2,010 bytes parent folder | download
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
61
62
63
64
65
66
67
68
69
70
71
72
73
/*=========================================================================
 *
 *  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 itkProgressTransformer_h
#define itkProgressTransformer_h

#include "itkProcessObject.h"
#include "itkCommand.h"

namespace itk
{
/**
 * \class ProgressTransformer
 * \brief Transforms progress updates from [0%, 100%] to desired scale.
 *
 * This class is designed to be allocated on the stack. Code sample:
 *
 *   ProgressTransformer progress2( 0.55f, 0.6f, this );
 *   multiThreader->ParallelizeArray(0, m_SomeArray.size(),
 *     [this]( SizeValueType index ) { this->ComputeInParallel( index ); },
 *     progress2.GetProcessObject() );
 *
 *
 * \sa ProgressReporter, ProcessObject
 * \ingroup ITKCommon
 */
class ITKCommon_EXPORT ProgressTransformer
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(ProgressTransformer);

  ProgressTransformer(float start, float end, ProcessObject * targetFilter);

  ProcessObject *
  GetProcessObject()
  {
    return m_Dummy.GetPointer();
  }

  void
  UpdateProgress();

  ~ProgressTransformer();

private:
  float m_Start;
  float m_End;

  ProcessObject * m_TargetFilter;

  ProcessObject::Pointer m_Dummy;

  using CommandType = SimpleMemberCommand<ProgressTransformer>;
  CommandType::Pointer m_ProgressCommand;

  unsigned long m_ProgressTag;
};
} // end namespace itk
#endif // itkProgressTransformer_h