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 84 85 86
|
/*=========================================================================
*
* 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 itkImageVectorOptimizerParametersHelper_h
#define itkImageVectorOptimizerParametersHelper_h
#include "itkOptimizerParametersHelper.h"
#include "itkImage.h"
namespace itk
{
/** \class ImageVectorOptimizerParametersHelper
* \brief Class to hold and manage parameters of type
* Image<Vector<...>,...>, used in Transforms, etc.
*
* \sa OptimizerParametersHelper
* \ingroup ITKCommon
*/
/* Can we template of Image type instead, but require that Image be of type
* Image< Vector< TValue, VVectorDimension >, VImageDimension > ? */
template <typename TValue, unsigned int VVectorDimension, unsigned int VImageDimension>
class ITK_TEMPLATE_EXPORT ImageVectorOptimizerParametersHelper : public OptimizerParametersHelper<TValue>
{
public:
/** The element type stored at each location in the Array. */
using ValueType = TValue;
using Self = ImageVectorOptimizerParametersHelper;
using Superclass = OptimizerParametersHelper<TValue>;
/** Image type that this class expects. */
using ParameterImageType = Image<Vector<TValue, VVectorDimension>, VImageDimension>;
using ParameterImagePointer = typename ParameterImageType::Pointer;
/** Type of the common data object used in OptimizerParameters */
using typename Superclass::CommonContainerType;
/** Default constructor. */
ImageVectorOptimizerParametersHelper() = default;
/** Set a new data pointer for *both* the Array and parameter image,
* pointing both to a different memory block.
* The size of the new memory block must be the same as current size of
* Array and the parameter image's buffer, in elements of TValue.
* Memory must be managed by caller afterwards. */
void
MoveDataPointer(CommonContainerType * container, TValue * pointer) override;
/** Set an image that holds the parameter data. \c container is a pointer
* of type itkArray to the object to which this helper is assigned.
*\c container will be pointed to the image data buffer, and set not to
* manage memory, so the image still manages its memory.
* A dynamic cast is performed on \c object to make sure its of proper type.
* Generally this will be called from
* OptimizerParameters::SetParameterObject. */
void
SetParametersObject(CommonContainerType * container, LightObject *) override;
~ImageVectorOptimizerParametersHelper() override = default;
private:
/** The parameter image used by the class */
ParameterImagePointer m_ParameterImage{};
};
} // namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
# include "itkImageVectorOptimizerParametersHelper.hxx"
#endif
#endif
|