Add AdditiveGaussianNoiseImageFilter Example

Author: Ben Wilson

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/CMakeLists.txt

@@ -0,0 +1,27 @@
+cmake_minimum_required(VERSION 3.10.2)
+
+project( AdditiveGaussianNoiseImageFilter )
+
+find_package( ITK REQUIRED )
+include( ${ITK_USE_FILE} )
+
+add_executable( AdditiveGaussianNoiseImageFilter Code.cxx )
+target_link_libraries( AdditiveGaussianNoiseImageFilter ${ITK_LIBRARIES} )
+
+install( TARGETS AdditiveGaussianNoiseImageFilter
+  DESTINATION bin/ITKExamples/Filtering/ImageFeature
+  COMPONENT Runtime
+)
+
+install( FILES Code.cxx CMakeLists.txt
+  DESTINATION share/ITKExamples/Code/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter
+  COMPONENT Code
+)
+
+enable_testing()
+add_test( NAME AdditiveGaussianNoiseImageFilterTest
+  COMMAND ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/AdditiveGaussianNoiseImageFilter
+  ${CMAKE_CURRENT_BINARY_DIR}/Gourds8.png
+  Output.mha
+  )
+

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/Code.cxx

@@ -0,0 +1,78 @@
+/*=========================================================================
+ *
+ *  Copyright Insight Software Consortium
+ *
+ *  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.
+ *
+ *=========================================================================*/
+#include "itkImage.h"
+#include "itkImageFileReader.h"
+#include "itkImageFileWriter.h"
+#include "itkAdditiveGaussianNoiseImageFilter.h"
+
+int main( int argc, char* argv[] )
+{
+  // Check for proper arguments, if not, explain usage.
+  if( argc != 5 )
+    {
+    std::cerr << "Usage: "<< std::endl;
+    std::cerr << argv[0];
+    std::cerr << " <InputFileName> <OutputFileName> [Mean] [Standard Deviation]";
+    std::cerr << std::endl;
+    return EXIT_FAILURE;
+    }
+    // Initialize and assign user provided variables
+  const std::string * inputImage = argv[1];
+  const std::string * outputImage = argv[2];
+  // get floating point numbers for the Mean and Standard Deviation to perform the algorithm
+  const double mean = std::stod(argv[3]);
+  const double deviation = std::stod(argv[4]);
+
+  constexpr unsigned int Dimension = 2;
+  // Use unsigned char so file will save to .png
+  using PixelType = unsigned char;
+  using ImageType = itk::Image< PixelType, Dimension >;
+
+  // read the old file to be converted
+  using ReaderType = itk::ImageFileReader< ImageType >;
+  ReaderType::Pointer reader = ReaderType::New();
+  reader->SetFileName( inputImage );
+
+  using ImageType = itk::Image< PixelType, Dimension >;
+
+  // Create the filter and apply the algorithm to the image
+  using FilterType = itk::AdditiveGaussianNoiseImageFilter< ImageType, ImageType >;
+  FilterType::Pointer filter = FilterType::New();
+  filter->SetInput( reader->GetOutput() );
+  filter->SetMean( mean ); // set the mean
+  filter->SetStandardDeviation( deviation ); // Set the standard deviation
+
+  // Set the writer to save file
+  using WriterType = itk::ImageFileWriter< ImageType >;
+  WriterType::Pointer writer = WriterType::New();
+  writer->SetFileName( outputImage );
+  writer->SetInput( filter->GetOutput() );
+
+//Write the output image
+  try
+    {
+    writer->Update();
+    }
+  catch( itk::ExceptionObject & error )
+    {
+    std::cerr << "Error: " << error << std::endl;
+    return EXIT_FAILURE;
+    }
+
+  return EXIT_SUCCESS;
+}

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/Code.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+import itk
+import sys
+
+if len(sys.argv) != 5:
+    print("Usage: " + sys.argv[0] + "< Input Image > < Output Image > [Mean] [Standard Deviation]")
+    sys.exit(1)
+
+inputImage = sys.argv[1]
+outputImage = sys.argv[2]
+mean = float(sys.argv[3])
+deviation = float(sys.argv[4])
+
+# Unsigned Char for png usage
+InputPixelType = itk.UC
+OutputPixelType = itk.UC
+Dimension = 2
+
+InputImageType = itk.Image[InputPixelType, Dimension]
+OutputImageType = itk.Image[OutputPixelType, Dimension]
+
+ReaderType = itk.ImageFileReader[InputImageType]
+reader = ReaderType.New()
+reader.SetFileName(inputImage)
+
+FilterType = itk.AdditiveGaussianNoiseImageFilter[InputImageType, InputImageType]
+AdditiveFilter = FilterType.New()
+AdditiveFilter.SetInput(reader.GetOutput())
+AdditiveFilter.SetMean(mean)
+AdditiveFilter.SetStandardDeviation(deviation)
+
+
+
+WriterType = itk.ImageFileWriter[OutputImageType]
+writer = WriterType.New()
+writer.SetFileName(outputImage)
+writer.SetInput(AdditiveFilter.GetOutput())
+
+writer.Update()

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/Documentation.rst

@@ -0,0 +1,42 @@
+Add Gaussian Noise to an Image
+=====================================================
+
+.. index::
+   single: DerivativeImageFilter
+   pair: image; random
+
+Synopsis
+--------
+
+Adds Gaussian Noise to a particular image
+
+
+Results
+-------
+.. figure:: Gourds8.png
+   :alt: Input Image
+   Input Image
+.. figure:: GourdsFilter.png
+   :alt: Output Image
+   Output Image
+
+
+Code
+----
+
+C++
+...
+
+.. literalinclude:: Code.cxx
+   :lines: 18-
+Python
+......
+
+.. literalinclude:: Code.py
+   :language: python
+   :lines: 1, 18-
+
+Classes demonstrated
+--------------------
+
+.. breathelink:: itk::AdditiveGaussianNoiseImageFilter

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/Gourds8.png

@@ -34,4 +34,9 @@ compare_to_baseline(EXAMPLE_NAME BilateralFilterAnImage
 add_example(FindZeroCrossings)
 #===================================
 
-endif()
+endif()
+
+add_example(AdditiveGaussianNoiseImageFilter)
+compare_to_baseline(EXAMPLE_NAME AdditiveGaussianNoiseImageFilter
+  BASELINE_PREFIX OutputBaseline
+  )

src/Filtering/ImageFeature/AdditiveGaussianNoiseImageFilter/GourdsFilter.png

@@ -16,3 +16,4 @@ ImageFeature
   ZeroCrossingBasedEdgeDecor/Documentation.rst
   BilateralFilterAnImage/Documentation.rst
   ExtractContoursFromImage/Documentation.rst
+  AdditiveGaussianNoiseImageFilter/Documentation.rst