itkHashImageFilter.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
*
*         http://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 itkHashImageFilter_h
#define itkHashImageFilter_h
 
 
#include "itkSimpleDataObjectDecorator.h"
#include "itkImageLinearConstIteratorWithIndex.h"
#include "itkCastImageFilter.h"
#include "itkByteSwapper.h"
 
 
namespace itk {
 
template < class TImageType >
class HashImageFilter:
    public CastImageFilter< TImageType, TImageType >
{
public:
  using Self = HashImageFilter;
  using Superclass = CastImageFilter< TImageType, TImageType >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
 
  using RegionType = typename TImageType::RegionType;
 
  itkNewMacro(Self);
 
  itkTypeMacro(HashImageFilter, CastImageFilter);
 
  using DataObjectPointer = typename DataObject::Pointer;
 
  using HashObjectType = SimpleDataObjectDecorator< std::string >;
 
  std::string GetHash() const
  { return this->GetHashOutput()->Get(); }
  HashObjectType* GetHashOutput()
  { return static_cast< HashObjectType *>( this->ProcessObject::GetOutput(1) ); }
  const HashObjectType* GetHashOutput() const
  { return static_cast<const HashObjectType *>( this->ProcessObject::GetOutput(1) ); }
 
  enum  HashFunction { SHA1, MD5 };
 
  itkSetMacro( HashFunction, HashFunction );
  itkGetMacro( HashFunction, HashFunction );
 
  using DataObjectPointerArraySizeType = ProcessObject::DataObjectPointerArraySizeType;
  using Superclass::MakeOutput;
  DataObjectPointer MakeOutput(DataObjectPointerArraySizeType idx) override;
 
protected:
 
  HashImageFilter();
 
  // virtual ~HashImageFilter(); // implementation not needed
 
  void PrintSelf(std::ostream & os, Indent indent) const 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:
  HashImageFilter(const Self &); //purposely not implemented
  void operator=(const Self &);  //purposely not implemented
 
 
  HashFunction m_HashFunction;
};
 
 
} // end namespace itk
 
 
#include "itkHashImageFilter.hxx"
 
#endif // itkHashImageFilter_h