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 Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn -
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::LabelMapMaskImageFilter::LabelMapMaskImageFilter() Default Constructor that takes no arguments and initializes default parametersprotectedLabelMapMaskImageFilter(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier 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.ImageFilter
getCPtr, swigReleaseMethods 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
-
LabelMapMaskImageFilter
protected LabelMapMaskImageFilter(long cPtr, boolean cMemoryOwn) -
LabelMapMaskImageFilter
public LabelMapMaskImageFilter()itk::simple::LabelMapMaskImageFilter::LabelMapMaskImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalizein classImageFilter
-
delete
public void delete()virtual itk::simple::LabelMapMaskImageFilter::~LabelMapMaskImageFilter() Destructor- Overrides:
deletein classImageFilter
-
setLabel
Self& itk::simple::LabelMapMaskImageFilter::SetLabel(uint64_t Label) The label to mask or to not mask, depending on the value of the Negated ivar. -
getLabel
uint64_t itk::simple::LabelMapMaskImageFilter::GetLabel() const The label to mask or to not mask, depending on the value of the Negated ivar. -
setBackgroundValue
public 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() . -
getBackgroundValue
public double getBackgroundValue()double itk::simple::LabelMapMaskImageFilter::GetBackgroundValue() const Set/Get the value used as "background" in the output image. Defaults to NumericTraits<PixelType>::ZeroValue() . -
setNegated
public void setNegated(boolean Negated) Self& itk::simple::LabelMapMaskImageFilter::SetNegated(bool Negated) Set/Get whether the Label should be masked or not. -
negatedOn
public void negatedOn()Self& itk::simple::LabelMapMaskImageFilter::NegatedOn() Set the value of Negated to true or false respectfully. -
negatedOff
public void negatedOff()Self& itk::simple::LabelMapMaskImageFilter::NegatedOff() -
getNegated
public boolean getNegated()bool itk::simple::LabelMapMaskImageFilter::GetNegated() const Set/Get whether the Label should be masked or not. -
setCrop
public 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. -
cropOn
public void cropOn()Self& itk::simple::LabelMapMaskImageFilter::CropOn() Set the value of Crop to true or false respectfully. -
cropOff
public void cropOff()Self& itk::simple::LabelMapMaskImageFilter::CropOff() -
getCrop
public boolean getCrop()bool itk::simple::LabelMapMaskImageFilter::GetCrop() const Set/Get whether the image size should be adjusted to the masked image or not. -
setCropBorder
Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to value -
setCropBorder
public void setCropBorder(long value) Self& itk::simple::LabelMapMaskImageFilter::SetCropBorder(unsigned int value) Set the values of the CropBorder vector all to value -
getCropBorder
std::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. -
getName
std::string itk::simple::LabelMapMaskImageFilter::GetName() const Name of this class- Overrides:
getNamein classProcessObject
-
toString
std::string itk::simple::LabelMapMaskImageFilter::ToString() const Print ourselves out- Overrides:
toStringin classProcessObject
-
execute
-