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
 *
 *         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 itkOptimizerParameters_h
#define itkOptimizerParameters_h
 
#include "itkArray.h"
#include "itkOptimizerParametersHelper.h"
 
#include <memory> // For unique_ptr.
 
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 typename Superclass::SizeValueType;

  using OptimizerParametersHelperType = OptimizerParametersHelper<TParametersValueType>;

  OptimizerParameters() = default;

  OptimizerParameters(const OptimizerParameters & rhs)
    : Array<TParametersValueType>(rhs)
  {
    // Note: don't copy the OptimizerParametersHelper.
    // The Array copy constructor will allocate new memory
    // and copy the data to it. So we end up here with a generic
    // OptimizerParameters data object even if 'rhs' points to
    // something different.
  }

  explicit OptimizerParameters(SizeValueType dimension)
    : Array<TParametersValueType>(dimension)
  {}

  OptimizerParameters(const ArrayType & array)
    : Array<TParametersValueType>(array)
  {}

  explicit OptimizerParameters(const SizeValueType dimension, const ValueType & value)
    : Array<TParametersValueType>(dimension, value)
  {}
 

  explicit OptimizerParameters(const ValueType * const inputData, const SizeValueType dimension)
    : Array<TParametersValueType>(inputData, dimension)
  {}
 

  void
  Initialize()
  {
    // Set the default OptimizerParametersHelper
    this->m_Helper = std::make_unique<OptimizerParametersHelperType>();
  }
 

  virtual void
  MoveDataPointer(TParametersValueType * pointer)
  {
    if (m_Helper == nullptr)
    {
      itkGenericExceptionMacro("OptimizerParameters::MoveDataPointer: "
                               "m_Helper must be set.");
    }
    this->m_Helper->MoveDataPointer(this, pointer);
  }


  virtual void
  SetParametersObject(LightObject * object)
  {
    if (m_Helper == nullptr)
    {
      itkGenericExceptionMacro("OptimizerParameters::SetParameterObject: "
                               "m_Helper must be set.");
    }
    this->m_Helper->SetParametersObject(this, object);
  }


  virtual void
  SetHelper(OptimizerParametersHelperType * helper)
  {
    this->m_Helper.reset(helper);
  }

  OptimizerParametersHelperType *
  GetHelper()
  {
    return m_Helper.get();
  }

  Self &
  operator=(const Self & rhs)
  {
    // Note: there's no need to copy the OptimizerParametersHelper.
    // Call the superclass implementation.
    this->ArrayType::operator=(rhs);
    return *this;
  }

 
  Self &
  operator=(const ArrayType & rhs)
  {
    // Call the superclass implementation
    this->ArrayType::operator=(rhs);
    return *this;
  }
 
  Self &
  operator=(const VnlVectorType & rhs)
  {
    // Call the superclass implementation
    this->ArrayType::operator=(rhs);
    return *this;
  }
 
  ~OptimizerParameters() override = default;
 
private:
  std::unique_ptr<OptimizerParametersHelperType> m_Helper{ std::make_unique<OptimizerParametersHelperType>() };
};
 
} // namespace itk
 
#endif