Package org.itk.simple
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 Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::UnsharpMaskImageFilter::UnsharpMaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
UnsharpMaskImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
clampOff()
Self& itk::simple::UnsharpMaskImageFilter::ClampOff()void
clampOn()
Self& itk::simple::UnsharpMaskImageFilter::ClampOn() Set the value of Clamp to true or false respectfully.void
delete()
virtual itk::simple::UnsharpMaskImageFilter::~UnsharpMaskImageFilter() DestructorImage itk::simple::UnsharpMaskImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
double
double itk::simple::UnsharpMaskImageFilter::GetAmount() const Set/Get amount of enhancement.boolean
getClamp()
bool itk::simple::UnsharpMaskImageFilter::GetClamp() constprotected static long
getName()
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.double
double itk::simple::UnsharpMaskImageFilter::GetThreshold() const Set/Get threshold for enhancement.void
setAmount
(double Amount) Self& itk::simple::UnsharpMaskImageFilter::SetAmount(double Amount) Set/Get amount of enhancement.void
setClamp
(boolean Clamp) Self& itk::simple::UnsharpMaskImageFilter::SetClamp(bool Clamp) Set/Get whether to clamp values to supported range of output type.void
setSigmas
(double s) Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing.void
setSigmas
(VectorDouble Sigmas) Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing.void
setThreshold
(double Threshold) Self& itk::simple::UnsharpMaskImageFilter::SetThreshold(double Threshold) Set/Get threshold for enhancement.protected static long
toString()
std::string itk::simple::UnsharpMaskImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, 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
-
UnsharpMaskImageFilter
protected UnsharpMaskImageFilter(long cPtr, boolean cMemoryOwn) -
UnsharpMaskImageFilter
public UnsharpMaskImageFilter()itk::simple::UnsharpMaskImageFilter::UnsharpMaskImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::UnsharpMaskImageFilter::~UnsharpMaskImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setSigmas
public 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. -
setSigmas
Self& itk::simple::UnsharpMaskImageFilter::SetSigmas(std::vector< double > Sigmas) Set/Get Sigma values measured in the units of image spacing. Default: 1.0. -
getSigmas
std::vector<double> itk::simple::UnsharpMaskImageFilter::GetSigmas() const Set/Get Sigma values measured in the units of image spacing. Default: 1.0. -
setAmount
public 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. -
getAmount
public double getAmount()double itk::simple::UnsharpMaskImageFilter::GetAmount() const Set/Get amount of enhancement. Usual range: 0.1 to 2.0. Default: 0.5. -
setThreshold
public void setThreshold(double Threshold) Self& itk::simple::UnsharpMaskImageFilter::SetThreshold(double Threshold) Set/Get threshold for enhancement. Default: 0. -
getThreshold
public double getThreshold()double itk::simple::UnsharpMaskImageFilter::GetThreshold() const Set/Get threshold for enhancement. Default: 0. -
setClamp
public void setClamp(boolean Clamp) Self& itk::simple::UnsharpMaskImageFilter::SetClamp(bool Clamp) Set/Get whether to clamp values to supported range of output type. -
clampOn
public void clampOn()Self& itk::simple::UnsharpMaskImageFilter::ClampOn() Set the value of Clamp to true or false respectfully. -
clampOff
public void clampOff()Self& itk::simple::UnsharpMaskImageFilter::ClampOff() -
getClamp
public boolean getClamp()bool itk::simple::UnsharpMaskImageFilter::GetClamp() const -
getName
std::string itk::simple::UnsharpMaskImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::UnsharpMaskImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::UnsharpMaskImageFilter::Execute(const Image &image1) Execute the filter on the input image
-