ThresholdingByCriterion

Performs a criterion based thresholding on a grayscale image.

Access to parameter description

For an introduction:

section Image Segmentation
section Binarization

For each input pixel, if its intensity meets the user-defined criterion, the output is set to 1 (foreground pixel); otherwise it is set to 0 (background pixel).

See also

See related examples

Function Syntax

This function returns outputBinaryImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
thresholdingByCriterion( std::shared_ptr< iolink::ImageView > inputGrayImage,
                         ThresholdingByCriterion::ComparisonCriterion comparisonCriterion,
                         double comparisonValue,
                         std::shared_ptr< iolink::ImageView > outputBinaryImage = NULL );

This function returns outputBinaryImage.

// Function prototype.
thresholding_by_criterion( input_gray_image,
                           comparison_criterion = ThresholdingByCriterion.ComparisonCriterion.GREATER_THAN_OR_EQUAL_TO,
                           comparison_value = 128,
                           output_binary_image = None )

This function returns outputBinaryImage.

// Function prototype.
public static IOLink.ImageView
ThresholdingByCriterion( IOLink.ImageView inputGrayImage,
                         ThresholdingByCriterion.ComparisonCriterion comparisonCriterion = ImageDev.ThresholdingByCriterion.ComparisonCriterion.GREATER_THAN_OR_EQUAL_TO,
                         double comparisonValue = 128,
                         IOLink.ImageView outputBinaryImage = null );

Class Syntax

// Command constructor.
ThresholdingByCriterion();

/// Gets the inputGrayImage parameter.
/// Input gray level image.
std::shared_ptr< iolink::ImageView > inputGrayImage() const;
/// Sets the inputGrayImage parameter.
/// Input gray level image.
void setInputGrayImage( std::shared_ptr< iolink::ImageView > inputGrayImage );

/// Gets the comparisonCriterion parameter.
/// The criterion of comparison.
ThresholdingByCriterion::ComparisonCriterion comparisonCriterion() const;
/// Sets the comparisonCriterion parameter.
/// The criterion of comparison.
void setComparisonCriterion( const ThresholdingByCriterion::ComparisonCriterion& comparisonCriterion );

/// Gets the comparisonValue parameter.
/// The threshold level.
double comparisonValue() const;
/// Sets the comparisonValue parameter.
/// The threshold level.
void setComparisonValue( const double& comparisonValue );

/// Gets the outputBinaryImage parameter.
/// The output binary image. Its dimensions are forced to the same values as the input.
std::shared_ptr< iolink::ImageView > outputBinaryImage() const;
/// Sets the outputBinaryImage parameter.
/// The output binary image. Its dimensions are forced to the same values as the input.
void setOutputBinaryImage( std::shared_ptr< iolink::ImageView > outputBinaryImage );


// Method to launch the command.
void execute();

# Property of the inputGrayImage parameter.
ThresholdingByCriterion.input_gray_image
# Property of the comparisonCriterion parameter.
ThresholdingByCriterion.comparison_criterion
# Property of the comparisonValue parameter.
ThresholdingByCriterion.comparison_value
# Property of the outputBinaryImage parameter.
ThresholdingByCriterion.output_binary_image

// Method to launch the command.
execute()

// Command constructor.
ThresholdingByCriterion()

// Property of the inputGrayImage parameter.
ThresholdingByCriterion.inputGrayImage
// Property of the comparisonCriterion parameter.
ThresholdingByCriterion.comparisonCriterion
// Property of the comparisonValue parameter.
ThresholdingByCriterion.comparisonValue
// Property of the outputBinaryImage parameter.
ThresholdingByCriterion.outputBinaryImage

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

inputGrayImage

Input gray level image.

Image

Binary, Label, Grayscale or Multispectral

nullptr

comparisonCriterion

The criterion of comparison.

LESS_THAN	Pixels having a value less than the comparison value are set to 1, others are set to 0.
LESS_THAN_OR_EQUAL_TO	Pixels having a value less than or equal to the comparison value are set to 1, others are set to 0.
EQUAL_TO	Pixels having a value equal to the comparison value are set to 1, others are set to 0.
GREATER_THAN_OR_EQUAL_TO	Pixels having a value greater than or equal to the comparison value are set to 1, others are set to 0.
GREATER_THAN	Pixels having a value greater than the comparison value are set to 1, others are set to 0.
NOT_EQUAL_TO	Pixels having a value different from the comparison value are set to 1, others are set to 0.

Enumeration

GREATER_THAN_OR_EQUAL_TO

comparisonValue

The threshold level.

Float64

Any value

128

outputBinaryImage

The output binary image. Its dimensions are forced to the same values as the input.

Image

nullptr

Object Examples

auto foam = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "foam.vip" );

ThresholdingByCriterion thresholdingByCriterionAlgo;
thresholdingByCriterionAlgo.setInputGrayImage( foam );
thresholdingByCriterionAlgo.setComparisonCriterion( ThresholdingByCriterion::ComparisonCriterion::NOT_EQUAL_TO );
thresholdingByCriterionAlgo.setComparisonValue( 0.0 );
thresholdingByCriterionAlgo.execute();

std::cout << "outputBinaryImage:" << thresholdingByCriterionAlgo.outputBinaryImage()->toString();

foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

thresholding_by_criterion_algo = imagedev.ThresholdingByCriterion()
thresholding_by_criterion_algo.input_gray_image = foam
thresholding_by_criterion_algo.comparison_criterion = imagedev.ThresholdingByCriterion.NOT_EQUAL_TO
thresholding_by_criterion_algo.comparison_value = 0.0
thresholding_by_criterion_algo.execute()

print( "output_binary_image:", str( thresholding_by_criterion_algo.output_binary_image ) )

ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

ThresholdingByCriterion thresholdingByCriterionAlgo = new ThresholdingByCriterion
{
    inputGrayImage = foam,
    comparisonCriterion = ThresholdingByCriterion.ComparisonCriterion.NOT_EQUAL_TO,
    comparisonValue = 0.0
};
thresholdingByCriterionAlgo.Execute();

Console.WriteLine( "outputBinaryImage:" + thresholdingByCriterionAlgo.outputBinaryImage.ToString() );

Function Examples

auto foam = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "foam.vip" );

auto result = thresholdingByCriterion( foam, ThresholdingByCriterion::ComparisonCriterion::NOT_EQUAL_TO, 0.0 );

std::cout << "outputBinaryImage:" << result->toString();

foam = imagedev.read_vip_image(imagedev_data.get_image_path("foam.vip"))

result = imagedev.thresholding_by_criterion( foam, imagedev.ThresholdingByCriterion.NOT_EQUAL_TO, 0.0 )

print( "output_binary_image:", str( result ) )

ImageView foam = Data.ReadVipImage( @"Data/images/foam.vip" );

IOLink.ImageView result = Processing.ThresholdingByCriterion( foam, ThresholdingByCriterion.ComparisonCriterion.NOT_EQUAL_TO, 0.0 );

Console.WriteLine( "outputBinaryImage:" + result.ToString() );

ThresholdingByCriterion

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax