1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
/*=========================================================================
*
* 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.
*
*=========================================================================*/
/*=========================================================================
*
* Portions of this file are subject to the VTK Toolkit Version 3 copyright.
*
* Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
*
* For complete copyright, license and disclaimer of warranty information
* please refer to the NOTICE file at the top of the ITK source tree.
*
*=========================================================================*/
#ifndef itkThresholdImageFilter_h
#define itkThresholdImageFilter_h
#include "itkInPlaceImageFilter.h"
#include "itkConceptChecking.h"
namespace itk
{
/** \class ThresholdImageFilter
* \brief Set image values to a user-specified value if they are below,
* above, or between simple threshold values.
*
* ThresholdImageFilter sets image values to a user-specified "outside"
* value (by default, "black") if the image values are below, above, or
* between simple threshold values.
*
* The available methods are:
*
* ThresholdAbove():
* The values greater than the threshold value are set to OutsideValue
*
* ThresholdBelow():
* The values less than the threshold value are set to OutsideValue
*
* ThresholdOutside():
* The values outside the threshold range (less than lower or greater
* than upper) are set to OutsideValue
*
* Note that these definitions indicate that pixels equal to the threshold
* value are not set to OutsideValue in any of these methods
*
* The pixels must support the operators >= and <=.
*
* \ingroup IntensityImageFilters MultiThreaded
* \ingroup ITKThresholding
*
* \wiki
* \wikiexample{ImageProcessing/ThresholdImageFilter,Threshold an image}
* \endwiki
*/
template< typename TImage >
class ITK_TEMPLATE_EXPORT ThresholdImageFilter:public InPlaceImageFilter< TImage, TImage >
{
public:
/** Standard class typedefs. */
typedef ThresholdImageFilter Self;
typedef InPlaceImageFilter< TImage, TImage > Superclass;
typedef SmartPointer< Self > Pointer;
typedef SmartPointer< const Self > ConstPointer;
/** Method for creation through the object factory. */
itkNewMacro(Self);
/** Run-time type information (and related methods). */
itkTypeMacro(ThresholdImageFilter, InPlaceImageFilter);
/** Typedef to describe the type of pixel. */
typedef typename TImage::PixelType PixelType;
/** The pixel type must support comparison operators. */
#ifdef ITK_USE_CONCEPT_CHECKING
// Begin concept checking
itkConceptMacro( PixelTypeComparableCheck,
( Concept::Comparable< PixelType > ) );
itkConceptMacro( PixelTypeOStreamWritableCheck,
( Concept::OStreamWritable< PixelType > ) );
// End concept checking
#endif
/** Set the "outside" pixel value. The default value
* NumericTraits<PixelType>::ZeroValue(). */
itkSetMacro(OutsideValue, PixelType);
/** Get the "outside" pixel value. */
itkGetConstMacro(OutsideValue, PixelType);
/** The values greater than or equal to the value are set to OutsideValue. */
void ThresholdAbove(const PixelType & thresh);
/** The values less than or equal to the value are set to OutsideValue. */
void ThresholdBelow(const PixelType & thresh);
/** The values outside the range are set to OutsideValue. */
void ThresholdOutside(const PixelType & lower, const PixelType & upper);
/** Set/Get methods to set the lower threshold. */
itkSetMacro(Lower, PixelType);
itkGetConstMacro(Lower, PixelType);
/** Set/Get methods to set the upper threshold. */
itkSetMacro(Upper, PixelType);
itkGetConstMacro(Upper, PixelType);
/** Additional typedefs for the input image. */
typedef TImage InputImageType;
typedef typename InputImageType::ConstPointer InputImagePointer;
typedef typename InputImageType::RegionType InputImageRegionType;
typedef typename InputImageType::PixelType InputImagePixelType;
/** Additional typedefs for the output image. */
typedef TImage OutputImageType;
typedef typename OutputImageType::Pointer OutputImagePointer;
typedef typename OutputImageType::RegionType OutputImageRegionType;
typedef typename OutputImageType::PixelType OutputImagePixelType;
protected:
ThresholdImageFilter();
~ThresholdImageFilter() ITK_OVERRIDE {}
void PrintSelf(std::ostream & os, Indent indent) const ITK_OVERRIDE;
/** ThresholdImageFilter can be implemented as a multithreaded filter.
* Therefore, this implementation provides a ThreadedGenerateData() routine
* which is called for each processing thread. The output image data is
* allocated automatically by the superclass prior to calling
* ThreadedGenerateData(). ThreadedGenerateData can only write to the
* portion of the output image specified by the parameter
* "outputRegionForThread".
*
* \sa ImageToImageFilter::ThreadedGenerateData(),
* ImageToImageFilter::GenerateData() */
void ThreadedGenerateData(const OutputImageRegionType & outputRegionForThread,
ThreadIdType threadId) ITK_OVERRIDE;
private:
ITK_DISALLOW_COPY_AND_ASSIGN(ThresholdImageFilter);
PixelType m_OutsideValue;
PixelType m_Lower;
PixelType m_Upper;
};
} // end namespace itk
#ifndef ITK_MANUAL_INSTANTIATION
#include "itkThresholdImageFilter.hxx"
#endif
#endif
|