itkHDF5TransformIO.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 itkHDF5TransformIO_h
#define itkHDF5TransformIO_h
 
#include "ITKIOTransformHDF5Export.h"
 
#include "itkTransformIOBase.h"
#include <memory>
#include <string>
 
// Avoids KWStyle error from forward declaration below.
namespace itk
{}
 
// Forward declaration of class H5::H5File
namespace H5
{
class H5File;
class PredType;
} // namespace H5
 
namespace itk
{
 
 
struct ITKIOTransformHDF5_EXPORT HDF5CommonPathNames
{
  //
  // HDF uses hierarchical paths to find particular data
  // in a file. These strings are used by both reading and
  // writing.
  static const std::string transformGroupName;
  static const std::string transformTypeName;
  static const std::string transformFixedNameMisspelled;
  static const std::string transformParamsNameMisspelled;
  static const std::string transformFixedName;
  static const std::string transformParamsName;
  static const std::string transformFixedNameCorrected;
  static const std::string transformParamsNameCorrected;
  static const std::string ItkVersion;
  static const std::string HDFVersion;
  static const std::string OSName;
  static const std::string OSVersion;
};
 
 
template <typename TParametersValueType>
class ITK_TEMPLATE_EXPORT HDF5TransformIOTemplate
  : public TransformIOBaseTemplate<TParametersValueType>
  , private HDF5CommonPathNames
{
public:
  using Self = HDF5TransformIOTemplate;
  using Superclass = TransformIOBaseTemplate<TParametersValueType>;
  using Pointer = SmartPointer<Self>;
  using typename Superclass::TransformType;
  using typename Superclass::TransformPointer;
  using typename Superclass::TransformListType;
  using ParametersType = typename TransformType::ParametersType;
  using ParametersValueType = typename TransformType::ParametersValueType;
  using FixedParametersType = typename TransformType::FixedParametersType;
  using FixedParametersValueType = typename TransformType::FixedParametersValueType;
 
  using ConstTransformListType = typename TransformIOBaseTemplate<ParametersValueType>::ConstTransformListType;
 
  itkOverrideGetNameOfClassMacro(HDF5TransformIOTemplate);
  itkNewMacro(Self);
  bool
  CanReadFile(const char *) override;
 
  bool
  CanWriteFile(const char *) override;
 
  void
  Read() override;
 
  void
  Write() override;
 
protected:
  HDF5TransformIOTemplate();
  ~HDF5TransformIOTemplate() override;
 
private:
  ParametersType
  ReadParameters(const std::string & DataSetName) const;
  FixedParametersType
  ReadFixedParameters(const std::string & DataSetName) const;
  void
  WriteParameters(const std::string & name, const ParametersType & parameters);
  void
  WriteFixedParameters(const std::string & name, const FixedParametersType & fixedParameters);
  void
  WriteString(const std::string & path, const std::string & value);
  void
  WriteString(const std::string & path, const char * s);
  void
  WriteOneTransform(const int transformIndex, const TransformType * curTransform);
  std::unique_ptr<H5::H5File> m_H5File;
 
  H5::PredType
  GetH5TypeFromString() const;
};
 
std::string ITKIOTransformHDF5_EXPORT
GetTransformName(int);
 
using HDF5TransformIO = HDF5TransformIOTemplate<double>;
 
} // end namespace itk
 
// Note: Explicit instantiation is done in itkHDF5TransformIO.cxx
 
#endif // itkHDF5TransformIO_h
 
#ifndef ITK_TEMPLATE_EXPLICIT_HDF5TransformIO
// Explicit instantiation is required to ensure correct dynamic_cast
// behavior across shared libraries.
//
// IMPORTANT: Since within the same compilation unit,
//            ITK_TEMPLATE_EXPLICIT_<classname> defined and undefined states
//            need to be considered. This code *MUST* be *OUTSIDE* the header
//            guards.
//
#if defined(ITKIOTransformHDF5_EXPORTS)
//   We are building this library
#  define ITKIOTransformHDF5_EXPORT_EXPLICIT ITK_FORWARD_EXPORT
#else
//   We are using this library
#  define ITKIOTransformHDF5_EXPORT_EXPLICIT ITKIOTransformHDF5_EXPORT
#endif
namespace itk
{
ITK_GCC_PRAGMA_DIAG_PUSH()
ITK_GCC_PRAGMA_DIAG(ignored "-Wattributes")
 
extern template class ITKIOTransformHDF5_EXPORT_EXPLICIT HDF5TransformIOTemplate<double>;
extern template class ITKIOTransformHDF5_EXPORT_EXPLICIT HDF5TransformIOTemplate<float>;
 
ITK_GCC_PRAGMA_DIAG_POP()
 
} // end namespace itk
#undef ITKIOTransformHDF5_EXPORT_EXPLICIT
#endif