SimpleITK  
sitkHashImageFilter.h
Go to the documentation of this file.
1 /*=========================================================================
2 *
3 * Copyright NumFOCUS
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0.txt
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 *=========================================================================*/
18 #ifndef sitkHashImageFilter_h
19 #define sitkHashImageFilter_h
20 
21 #include "sitkMacro.h"
23 #include "sitkImage.h"
24 #include "sitkBasicFilters.h"
25 #include "sitkImageFilter.h"
26 #include "sitkProcessObject.h"
27 
28 namespace itk::simple {
29 
36  : public ProcessObject {
37  public:
39 
40  // function pointer type
41  typedef std::string (Self::*MemberFunctionType)( const Image& );
42 
43  // this filter works with all itk::Image and itk::VectorImage types.
44  using PixelIDTypeList = typelist2::append<BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type;
45 
46  ~HashImageFilter() override;
47 
49 
50  enum HashFunction { SHA1, MD5 };
51  SITK_RETURN_SELF_TYPE_HEADER SetHashFunction ( HashFunction hashFunction );
52  HashFunction GetHashFunction () const;
53 
55  std::string GetName() const override { return std::string ( "Hash"); }
56 
57  // Print ourselves out
58  std::string ToString() const override;
59 
60  std::string Execute ( const Image& );
61 
62 
63  private:
65 
66  template <class TImageType> std::string ExecuteInternal ( const Image& image );
67  template <class TImageType> std::string ExecuteInternalLabelImage ( const Image& image );
68 
69  // friend to get access to executeInternal member
70  friend struct detail::MemberFunctionAddressor<MemberFunctionType>;
71  friend struct detail::ExecuteInternalLabelImageAddressor<MemberFunctionType>;
72 
73  std::unique_ptr<detail::MemberFunctionFactory<MemberFunctionType> > m_MemberFactory;
74  };
75 
77  }
78 #endif
itk::simple::Image
The Image class for SimpleITK.
Definition: sitkImage.h:76
itk::simple::HashImageFilter::PixelIDTypeList
typelist2::append< BasicPixelIDTypeList, ComplexPixelIDTypeList, VectorPixelIDTypeList >::type PixelIDTypeList
Definition: sitkHashImageFilter.h:44
sitkBasicFilters.h
itk::simple::HashImageFilter::HashFunction
HashFunction
Definition: sitkHashImageFilter.h:50
itk::simple::detail::MemberFunctionAddressor
Definition: sitkDetail.h:28
itk::simple::HashImageFilter::m_MemberFactory
std::unique_ptr< detail::MemberFunctionFactory< MemberFunctionType > > m_MemberFactory
Definition: sitkHashImageFilter.h:73
sitkImage.h
HashFunction
sitkMemberFunctionFactory.h
sitkImageFilter.h
sitkProcessObject.h
sitkMacro.h
itk::simple::detail::ExecuteInternalLabelImageAddressor
Definition: sitkDetail.h:93
itk::simple::HashImageFilter
Compute the sha1 or md5 hash of an image.
Definition: sitkHashImageFilter.h:35
itk::simple::HashImageFilter::GetName
std::string GetName() const override
Definition: sitkHashImageFilter.h:55
SITKBasicFilters_EXPORT
#define SITKBasicFilters_EXPORT
Definition: sitkBasicFilters.h:52
itk::simple::Hash
std::string Hash(const Image &image, HashImageFilter::HashFunction function=HashImageFilter::SHA1)
itk::simple::HashImageFilter::m_HashFunction
HashFunction m_HashFunction
Definition: sitkHashImageFilter.h:64
itk::simple::ProcessObject
Base class for SimpleITK classes based on ProcessObject.
Definition: sitkProcessObject.h:51
itk::simple
Definition: sitkAdditionalProcedures.h:28
itk::simple::HashImageFilter::SHA1
@ SHA1
Definition: sitkHashImageFilter.h:50