itkMetaConverterBase.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 itkMetaConverterBase_h
#define itkMetaConverterBase_h
 
#include "itkSpatialObject.h"
#include "metaObject.h"
 
namespace itk
{
 
template <unsigned int VDimension = 3>
class ITK_TEMPLATE_EXPORT MetaConverterBase : public Object
{
public:
 
  using Self = MetaConverterBase;
  using Superclass = Object;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  itkOverrideGetNameOfClassMacro(MetaConverterBase);
 
  using SpatialObjectType = SpatialObject<VDimension>;
  using SpatialObjectPointer = typename SpatialObjectType::Pointer;
  using SpatialObjectConstPointer = typename SpatialObjectType::ConstPointer;
  using MetaObjectType = MetaObject;
 
  itkSetMacro(MetaIOVersion, unsigned int);
  itkGetConstMacro(MetaIOVersion, unsigned int);
 
  virtual SpatialObjectPointer
  ReadMeta(const char * name);
 
  virtual bool
  WriteMeta(const SpatialObjectType * spatialObject, const char * name);
 
  void
  MetaObjectToSpatialObjectBase(const MetaObjectType * mo, SpatialObjectPointer spatialObject);
 
  void
  SpatialObjectToMetaObjectBase(SpatialObjectConstPointer spatialObject, MetaObjectType * mo);
 
  virtual SpatialObjectPointer
  MetaObjectToSpatialObject(const MetaObjectType * mo) = 0;
 
  virtual MetaObjectType *
  SpatialObjectToMetaObject(const SpatialObjectType * spatialObject) = 0;
 
  itkSetMacro(WriteImagesInSeparateFile, bool);
  itkGetConstMacro(WriteImagesInSeparateFile, bool);
  itkBooleanMacro(WriteImagesInSeparateFile);
protected:
  MetaConverterBase() = default;
  ~MetaConverterBase() override = default;
 
  virtual MetaObjectType *
  CreateMetaObject() = 0;
 
 
private:
  bool         m_WriteImagesInSeparateFile{ false };
  unsigned int m_MetaIOVersion{ 0 };
};
 
} // namespace itk
 
#ifndef ITK_MANUAL_INSTATIATION
#  include "itkMetaConverterBase.hxx"
#endif
 
#endif // itkMetaConverterBase_h