Class UnsharpMaskImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.UnsharpMaskImageFilter
Edge enhancement filter.
This filter subtracts a smoothed version of the image from the image
to achieve the edge enhancing effect. https://en.wikipedia.org/w/index.php?title=Unsharp_masking&oldid=7
50486803#Photographic_unsharp_masking
It has configurable amount, radius (sigma) and threshold, and whether
to clamp the resulting values to the range of output type.
Formula: sharpened=original+[ itk::Math::abs (original-blurred)-threshold]*amount
If clamping is turned off (it is on by default), casting to output
pixel format is done using C++ defaults, meaning that values are not
clamped but rather wrap around e.g. 260 -> 4 (unsigned char).
See:
 ImageToImageFilter
 SmoothingRecursiveGaussianImageFilter
 RescaleIntensityImageFilter
 itk::simple::UnsharpMask for the procedural interface
 itk::UnsharpMaskImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkUnsharpMaskImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::UnsharpMaskImageFilter::UnsharpMaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedUnsharpMaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoidclampOff()Self& itk::simple::UnsharpMaskImageFilter::ClampOff()voidclampOn()Self& itk::simple::UnsharpMaskImageFilter::ClampOn() Set the value of Clamp to true or false respectfully.voiddelete()virtual itk::simple::UnsharpMaskImageFilter::~UnsharpMaskImageFilter() DestructorImage itk::simple::UnsharpMaskImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected voidfinalize()doubledouble itk::simple::UnsharpMaskImageFilter::GetAmount() const Set/Get amount of enhancement.booleangetClamp()bool itk::simple::UnsharpMaskImageFilter::GetClamp() const Set/Get whether to clamp values to supported range of output type.protected static longgetName()std::string itk::simple::UnsharpMaskImageFilter::GetName() const Name of this classstd::vector<double> itk::simple::UnsharpMaskImageFilter::GetSigmas() const Set/Get Sigma values measured in the units of image spacing.doubledouble itk::simple::UnsharpMaskImageFilter::GetThreshold() const Set/Get threshold for enhancement.voidsetAmount(double Amount) Self& itk::simple::UnsharpMaskImageFilter::SetAmount(double Amount) Set/Get amount of enhancement.voidsetClamp(boolean Clamp) Self& itk::simple::UnsharpMaskImageFilter::SetClamp(bool Clamp) Set/Get whether to clamp values to supported range of output type.voidsetSigmas(double s) Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing.voidsetSigmas(VectorDouble Sigmas) Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing.voidsetThreshold(double Threshold) Self& itk::simple::UnsharpMaskImageFilter::SetThreshold(double Threshold) Set/Get threshold for enhancement.protected static longtoString()std::string itk::simple::UnsharpMaskImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFiltergetCPtr, swigReleaseMethods inherited from class org.itk.simple.ProcessObjectabort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
- 
Constructor Details- 
UnsharpMaskImageFilterprotected UnsharpMaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
UnsharpMaskImageFilterpublic UnsharpMaskImageFilter()itk::simple::UnsharpMaskImageFilter::UnsharpMaskImageFilter() Default Constructor that takes no arguments and initializes default parameters
 
- 
- 
Method Details- 
getCPtr
- 
swigRelease
- 
finalizeprotected void finalize()- Overrides:
- finalizein class- ImageFilter
 
- 
deletepublic void delete()virtual itk::simple::UnsharpMaskImageFilter::~UnsharpMaskImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setSigmaspublic void setSigmas(double s) Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing. Default: 1.0.
- 
setSigmasSelf& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing. Default: 1.0.
- 
getSigmasstd::vector<double> itk::simple::UnsharpMaskImageFilter::GetSigmas() const Set/Get Sigma values measured in the units of image spacing. Default: 1.0.
- 
setAmountpublic void setAmount(double Amount) Self& itk::simple::UnsharpMaskImageFilter::SetAmount(double Amount) Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.
- 
getAmountpublic double getAmount()double itk::simple::UnsharpMaskImageFilter::GetAmount() const Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5.
- 
setThresholdpublic void setThreshold(double Threshold) Self& itk::simple::UnsharpMaskImageFilter::SetThreshold(double Threshold) Set/Get threshold for enhancement. Default: 0.
- 
getThresholdpublic double getThreshold()double itk::simple::UnsharpMaskImageFilter::GetThreshold() const Set/Get threshold for enhancement. Default: 0.
- 
setClamppublic void setClamp(boolean Clamp) Self& itk::simple::UnsharpMaskImageFilter::SetClamp(bool Clamp) Set/Get whether to clamp values to supported range of output type. Default: On.
- 
clampOnpublic void clampOn()Self& itk::simple::UnsharpMaskImageFilter::ClampOn() Set the value of Clamp to true or false respectfully.
- 
clampOffpublic void clampOff()Self& itk::simple::UnsharpMaskImageFilter::ClampOff()
- 
getClamppublic boolean getClamp()bool itk::simple::UnsharpMaskImageFilter::GetClamp() const Set/Get whether to clamp values to supported range of output type. Default: On.
- 
getNamestd::string itk::simple::UnsharpMaskImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::UnsharpMaskImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-