itkOptimizerParameters.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  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
 *
 *         http://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 itkOptimizerParameters_h
#define itkOptimizerParameters_h
 
#include "itkArray.h"
#include "itkOptimizerParametersHelper.h"
 
namespace itk
{
template <typename TParametersValueType>
class ITK_TEMPLATE_EXPORT OptimizerParameters : public Array<TParametersValueType>
{
public:
  using ValueType = TParametersValueType;
  using Self = OptimizerParameters;
  using Superclass = Array<TParametersValueType>;
  using ArrayType = Superclass;
  using VnlVectorType = typename Superclass::VnlVectorType;
  using SizeValueType = typename Superclass::SizeValueType;
 
  using OptimizerParametersHelperType = OptimizerParametersHelper<TParametersValueType>;
 
  OptimizerParameters();
 
  OptimizerParameters(const OptimizerParameters & rhs);
 
  explicit OptimizerParameters(SizeValueType dimension);
 
  OptimizerParameters(const ArrayType & array);
 
  void
  Initialize();
 
  virtual void
  MoveDataPointer(TParametersValueType * pointer);
 
  virtual void
  SetParametersObject(LightObject * object);
 
  virtual void
  SetHelper(OptimizerParametersHelperType * helper);
 
  OptimizerParametersHelperType *
  GetHelper()
  {
    return m_Helper;
  }
 
  const Self &
  operator=(const Self & rhs);
 
  const Self &
  operator=(const ArrayType & rhs);
 
  const Self &
  operator=(const VnlVectorType & rhs);
 
  ~OptimizerParameters() override;
 
private:
  OptimizerParametersHelperType * m_Helper;
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkOptimizerParameters.hxx"
#endif
 
#endif