File: itkOptimizerParametersHelper.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 (83 lines) | stat: -rw-r--r-- 2,918 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
74
75
76
77
78
79
80
81
82
83
/*=========================================================================
 *
 *  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 itkOptimizerParametersHelper_h
#define itkOptimizerParametersHelper_h

#include "itkObject.h"
#include "itkArray.h"

namespace itk
{
/** \class OptimizerParametersHelper
 *  \brief Basic helper class to manage parameter data as an Array type,
 *  the default type.
 *
 * \ingroup ITKCommon
 */

template <typename TValue>
class ITK_TEMPLATE_EXPORT OptimizerParametersHelper
{
public:
  /** The element type stored at each location in the Array. */
  using ValueType = TValue;
  using Self = OptimizerParametersHelper;

  /** Type of common data object used by OptimizerParameters. */
  using CommonContainerType = Array<TValue>;

  /** Default constructor. Nothing to do. */
  OptimizerParametersHelper() = default;

  /** Set a new data pointer for the parameter data, pointing it to a different
   * memory block. The size of the new memory block must equal the current
   * size, in elements of TValue.
   * This call is passed to the assigned OptimizerParametersHelper.
   * \warning Memory must be managed by caller after this call.
   * \c container is the OptimizerParameters object to which this helper
   * is assigned.
   * Generally this will be called from the OptimizerParameters object to
   * which this helper is assigned.
   */
  virtual void
  MoveDataPointer(CommonContainerType * container, TValue * pointer)
  {
    container->SetData(pointer, container->GetSize(), false /*LetArrayManageMemory*/);
  }

  /** Set an object that holds the parameters. Used by
   * derived classes that use an object other than itkArray to hold parameter
   * data. The derived class must check that the object is the correct type.
   * Generally this will be called from the OptimizerParameters object to
   * which this helper is assigned.
   * \c container is the OptimizerParameters object to which this helper
   * is assigned.
   */
  virtual void
  SetParametersObject(CommonContainerType *, LightObject *)
  {
    itkGenericExceptionMacro("OptimizerParametersHelper::SetParametersObject: "
                             "Not implemented for base class.");
  }

  virtual ~OptimizerParametersHelper() = default;
};

} // namespace itk

#endif