itkTestingHashImageFilter.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 itkTestingHashImageFilter_h
#define itkTestingHashImageFilter_h
 
 
#include "itkSimpleDataObjectDecorator.h"
#include "itkInPlaceImageFilter.h"
 
namespace itk::Testing
{
class HashImageFilterEnums
{
public:
  enum class HashFunction : uint8_t
  {
    MD5
  };
};
// Define how to print enumeration
extern std::ostream &
operator<<(std::ostream & out, HashImageFilterEnums::HashFunction value);

template <typename TImageType>
class ITK_TEMPLATE_EXPORT HashImageFilter : public InPlaceImageFilter<TImageType, TImageType>
{
public:
  ITK_DISALLOW_COPY_AND_MOVE(HashImageFilter);

  using Self = HashImageFilter;
  using Superclass = InPlaceImageFilter<TImageType, TImageType>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
 
  using RegionType = typename TImageType::RegionType;

  itkNewMacro(Self);

  itkOverrideGetNameOfClassMacro(HashImageFilter);

  using DataObjectPointer = typename DataObject::Pointer;

  using HashObjectType = SimpleDataObjectDecorator<std::string>;

  [[nodiscard]] std::string
  GetHash() const
  {
    return this->GetHashOutput()->Get();
  }
  HashObjectType *
  GetHashOutput()
  {
    return static_cast<HashObjectType *>(this->ProcessObject::GetOutput(1));
  }
  [[nodiscard]] const HashObjectType *
  GetHashOutput() const
  {
    return static_cast<const HashObjectType *>(this->ProcessObject::GetOutput(1));
  }

  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer
  MakeOutput(DataObjectPointerArraySizeType idx) override;
 
  using HashFunctionEnum = HashImageFilterEnums::HashFunction;
#if !defined(ITK_LEGACY_REMOVE)
  static constexpr HashFunctionEnum MD5 = HashFunctionEnum::MD5;
#endif

  itkSetEnumMacro(HashFunction, HashFunctionEnum);
  itkGetMacro(HashFunction, HashFunctionEnum);
 
protected:
  HashImageFilter();
 
  // virtual ~HashImageFilter(); // implementation not needed
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;

  void
  ThreadedGenerateData(const typename Superclass::OutputImageRegionType &, ThreadIdType) override
  {}
  void
  DynamicThreadedGenerateData(const typename Superclass::OutputImageRegionType &) override
  {}
 
  // See superclass for doxygen documentation
  //
  // This method is to do work after the superclass potential threaded
  // copy.
  void
  AfterThreadedGenerateData() override;
 
  // See superclass for doxygen documentation
  //
  // Override since the filter produces all of its output
  void
  EnlargeOutputRequestedRegion(DataObject * data) override;
 
private:
  HashFunctionEnum m_HashFunction{ HashFunctionEnum::MD5 };
};
 
} // namespace itk::Testing
 
 
#include "itkTestingHashImageFilter.hxx"
 
#endif // itkTestingHashImageFilter_h