Class LabelMapMaskImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.LabelMapMaskImageFilter
Mask and image with a LabelMap .
LabelMapMaskImageFilter mask the content of an input image according to the content of the
input LabelMap . The masked pixel of the input image are set to the BackgroundValue. LabelMapMaskImageFilter can keep the input image for one label only, with Negated = false
(the default) or it can mask the input image for a single label, when
Negated equals true. In Both cases, the label is set with SetLabel() .
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/q6auw4
See:
 LabelMapToBinaryImageFilter , LabelMapToLabelImageFilter
 itk::simple::LabelMapMask for the procedural interface
 itk::LabelMapMaskImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkLabelMapMaskImageFilter.h
- 
Field SummaryFields inherited from class org.itk.simple.ProcessObjectswigCMemOwn
- 
Constructor SummaryConstructorsModifierConstructorDescriptionitk::simple::LabelMapMaskImageFilter::LabelMapMaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedLabelMapMaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
Method SummaryModifier and TypeMethodDescriptionvoidcropOff()Self& itk::simple::LabelMapMaskImageFilter::CropOff()voidcropOn()Self& itk::simple::LabelMapMaskImageFilter::CropOn() Set the value of Crop to true or false respectfully.voiddelete()virtual itk::simple::LabelMapMaskImageFilter::~LabelMapMaskImageFilter() DestructorImage itk::simple::LabelMapMaskImageFilter::Execute(const Image &labelMapImage, const Image &featureImage) Execute the filter on the input imageprotected voidfinalize()doubledouble itk::simple::LabelMapMaskImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image.protected static longbooleangetCrop()bool itk::simple::LabelMapMaskImageFilter::GetCrop() const Set/Get whether the image size should be adjusted to the masked image or not.std::vector<unsigned int> itk::simple::LabelMapMaskImageFilter::GetCropBorder() const Set/Get the border added to the mask before the crop.getLabel()uint64_t itk::simple::LabelMapMaskImageFilter::GetLabel() const The label to mask or to not mask, depending on the value of the Negated ivar.getName()std::string itk::simple::LabelMapMaskImageFilter::GetName() const Name of this classbooleanbool itk::simple::LabelMapMaskImageFilter::GetNegated() const Set/Get whether the Label should be masked or not.voidSelf& itk::simple::LabelMapMaskImageFilter::NegatedOff()voidSelf& itk::simple::LabelMapMaskImageFilter::NegatedOn() Set the value of Negated to true or false respectfully.voidsetBackgroundValue(double BackgroundValue) Self& itk::simple::LabelMapMaskImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image.voidsetCrop(boolean Crop) Self& itk::simple::LabelMapMaskImageFilter::SetCrop(bool Crop) Set/Get whether the image size should be adjusted to the masked image or not.voidsetCropBorder(long value) Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to valuevoidsetCropBorder(VectorUInt32 CropBorder) Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to valuevoidsetLabel(BigInteger Label) Self& itk::simple::LabelMapMaskImageFilter::SetLabel(uint64_t Label) The label to mask or to not mask, depending on the value of the Negated ivar.voidsetNegated(boolean Negated) Self& itk::simple::LabelMapMaskImageFilter::SetNegated(bool Negated) Set/Get whether the Label should be masked or not.protected static longtoString()std::string itk::simple::LabelMapMaskImageFilter::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- 
LabelMapMaskImageFilterprotected LabelMapMaskImageFilter(long cPtr, boolean cMemoryOwn) 
- 
LabelMapMaskImageFilterpublic LabelMapMaskImageFilter()itk::simple::LabelMapMaskImageFilter::LabelMapMaskImageFilter() 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::LabelMapMaskImageFilter::~LabelMapMaskImageFilter() Destructor- Overrides:
- deletein class- ImageFilter
 
- 
setLabelSelf& itk::simple::LabelMapMaskImageFilter::SetLabel(uint64_t Label) The label to mask or to not mask, depending on the value of the Negated ivar.
- 
getLabeluint64_t itk::simple::LabelMapMaskImageFilter::GetLabel() const The label to mask or to not mask, depending on the value of the Negated ivar.
- 
setBackgroundValuepublic void setBackgroundValue(double BackgroundValue) Self& itk::simple::LabelMapMaskImageFilter::SetBackgroundValue(double BackgroundValue) Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue() .
- 
getBackgroundValuepublic double getBackgroundValue()double itk::simple::LabelMapMaskImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue() .
- 
setNegatedpublic void setNegated(boolean Negated) Self& itk::simple::LabelMapMaskImageFilter::SetNegated(bool Negated) Set/Get whether the Label should be masked or not.
- 
negatedOnpublic void negatedOn()Self& itk::simple::LabelMapMaskImageFilter::NegatedOn() Set the value of Negated to true or false respectfully.
- 
negatedOffpublic void negatedOff()Self& itk::simple::LabelMapMaskImageFilter::NegatedOff()
- 
getNegatedpublic boolean getNegated()bool itk::simple::LabelMapMaskImageFilter::GetNegated() const Set/Get whether the Label should be masked or not.
- 
setCroppublic void setCrop(boolean Crop) Self& itk::simple::LabelMapMaskImageFilter::SetCrop(bool Crop) Set/Get whether the image size should be adjusted to the masked image or not.
- 
cropOnpublic void cropOn()Self& itk::simple::LabelMapMaskImageFilter::CropOn() Set the value of Crop to true or false respectfully.
- 
cropOffpublic void cropOff()Self& itk::simple::LabelMapMaskImageFilter::CropOff()
- 
getCroppublic boolean getCrop()bool itk::simple::LabelMapMaskImageFilter::GetCrop() const Set/Get whether the image size should be adjusted to the masked image or not.
- 
setCropBorderSelf& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to value
- 
setCropBorderpublic void setCropBorder(long value) Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to value
- 
getCropBorderstd::vector<unsigned int> itk::simple::LabelMapMaskImageFilter::GetCropBorder() const Set/Get the border added to the mask before the crop. The default is 0 on all the axes.
- 
getNamestd::string itk::simple::LabelMapMaskImageFilter::GetName() const Name of this class- Overrides:
- getNamein class- ProcessObject
 
- 
toStringstd::string itk::simple::LabelMapMaskImageFilter::ToString() const Print ourselves out- Overrides:
- toStringin class- ProcessObject
 
- 
execute
 
-