Class RenyiEntropyThresholdImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.RenyiEntropyThresholdImageFilter
Threshold an image using the RenyiEntropy Threshold.
This filter creates a binary thresholded image that separates an image
into foreground and background components. The filter computes the
threshold using the RenyiEntropyThresholdCalculator and applies that threshold to the input image using the BinaryThresholdImageFilter .
Richard Beare. Department of Medicine, Monash University, Melbourne,
Australia.
Gaetan Lehmann. Biologie du Developpement et de la Reproduction, INRA
de Jouy-en-Josas, France.
 This implementation was taken from the Insight Journal paper: https://doi.org/10.54294/efycla
See:
 HistogramThresholdImageFilter
 itk::simple::RenyiEntropyThreshold for the procedural interface
 itk::RenyiEntropyThresholdImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkRenyiEntropyThresholdImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::RenyiEntropyThresholdImageFilter::RenyiEntropyThresholdImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedRenyiEntropyThresholdImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoiddelete()virtual itk::simple::RenyiEntropyThresholdImageFilter::~RenyiEntropyThresholdImageFilter() DestructorImage itk::simple::RenyiEntropyThresholdImageFilter::Execute(const Image &image, const Image &maskImage) Execute the filter on the input imageImage itk::simple::RenyiEntropyThresholdImageFilter::Execute(const Image &image, const Image &maskImage) Execute the filter on the input imageprotected voidfinalize()protected static longshortuint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetInsideValue() const Get the "inside" pixel value.booleanbool itk::simple::RenyiEntropyThresholdImageFilter::GetMaskOutput() constshortuint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetMaskValue() constgetName()std::string itk::simple::RenyiEntropyThresholdImageFilter::GetName() const Name of this classlonguint32_t itk::simple::RenyiEntropyThresholdImageFilter::GetNumberOfHistogramBins() constshortuint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetOutsideValue() const Get the "outside" pixel value.doubledouble itk::simple::RenyiEntropyThresholdImageFilter::GetThreshold() const Get the computed threshold.voidSelf& itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOff()voidSelf& itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOn() Set the value of MaskOutput to true or false respectfully.voidsetInsideValue(short InsideValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetInsideValue(uint8_t InsideValue) Set the "inside" pixel value.voidsetMaskOutput(boolean MaskOutput) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetMaskOutput(bool MaskOutput) Do you want the output to be masked by the mask used in histogram construction.voidsetMaskValue(short MaskValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetMaskValue(uint8_t MaskValue) The value in the mask image, if used, indicating voxels that should be included.voidsetNumberOfHistogramBins(long NumberOfHistogramBins) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins) Set/Get the number of histogram bins.voidsetOutsideValue(short OutsideValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetOutsideValue(uint8_t OutsideValue) Set the "outside" pixel value.protected static longtoString()std::string itk::simple::RenyiEntropyThresholdImageFilter::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- 
RenyiEntropyThresholdImageFilterprotected RenyiEntropyThresholdImageFilter(long cPtr, boolean cMemoryOwn) 
- 
RenyiEntropyThresholdImageFilterpublic RenyiEntropyThresholdImageFilter()itk::simple::RenyiEntropyThresholdImageFilter::RenyiEntropyThresholdImageFilter() 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::RenyiEntropyThresholdImageFilter::~RenyiEntropyThresholdImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setInsideValuepublic void setInsideValue(short InsideValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetInsideValue(uint8_t InsideValue) Set the "inside" pixel value.
- 
getInsideValuepublic short getInsideValue()uint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetInsideValue() const Get the "inside" pixel value.
- 
setOutsideValuepublic void setOutsideValue(short OutsideValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetOutsideValue(uint8_t OutsideValue) Set the "outside" pixel value. The default value NumericTraits<OutputPixelType>::Zero.
- 
getOutsideValuepublic short getOutsideValue()uint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetOutsideValue() const Get the "outside" pixel value.
- 
setNumberOfHistogramBinspublic void setNumberOfHistogramBins(long NumberOfHistogramBins) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetNumberOfHistogramBins(uint32_t NumberOfHistogramBins) Set/Get the number of histogram bins.
- 
getNumberOfHistogramBinspublic long getNumberOfHistogramBins()uint32_t itk::simple::RenyiEntropyThresholdImageFilter::GetNumberOfHistogramBins() const
- 
setMaskOutputpublic void setMaskOutput(boolean MaskOutput) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetMaskOutput(bool MaskOutput) Do you want the output to be masked by the mask used in histogram construction. Only relevant if masking is in use.
- 
maskOutputOnpublic void maskOutputOn()Self& itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOn() Set the value of MaskOutput to true or false respectfully.
- 
maskOutputOffpublic void maskOutputOff()Self& itk::simple::RenyiEntropyThresholdImageFilter::MaskOutputOff()
- 
getMaskOutputpublic boolean getMaskOutput()bool itk::simple::RenyiEntropyThresholdImageFilter::GetMaskOutput() const
- 
setMaskValuepublic void setMaskValue(short MaskValue) Self& itk::simple::RenyiEntropyThresholdImageFilter::SetMaskValue(uint8_t MaskValue) The value in the mask image, if used, indicating voxels that should be included. Default is the max of pixel type, as in the MaskedImageToHistogramFilter
- 
getMaskValuepublic short getMaskValue()uint8_t itk::simple::RenyiEntropyThresholdImageFilter::GetMaskValue() const
- 
getThresholdpublic double getThreshold()double itk::simple::RenyiEntropyThresholdImageFilter::GetThreshold() const Get the computed threshold. This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
- 
getNamestd::string itk::simple::RenyiEntropyThresholdImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::RenyiEntropyThresholdImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
- 
execute
 
-