LabelFiltering

Removes objects from a label image based on measurement criteria.

Access to parameter description

For an introduction:

section Image Analysis
section Label Filtering

This algorithm applies the criteria defined by the selected filter to the input image. Then it outputs the corresponding filtered label image.

The input filter contains the criteria to preserve objects from the input label image. These criteria are defined by one or several analysis measurements ranges.

If the label input image has a coordinate system unit defined in its calibration property, the filter limit values are expressed in this coordinate system unit.

See also

Function Syntax

This function returns outputLabelImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
labelFiltering( std::shared_ptr< iolink::ImageView > inputLabelImage,
                std::shared_ptr< iolink::ImageView > inputIntensityImage,
                std::string inputFilter,
                std::shared_ptr< iolink::ImageView > outputLabelImage = NULL );

This function returns outputLabelImage.

// Function prototype.
label_filtering( input_label_image,
                 input_intensity_image,
                 input_filter = "",
                 output_label_image = None )

This function returns outputLabelImage.

// Function prototype.
public static IOLink.ImageView
LabelFiltering( IOLink.ImageView inputLabelImage,
                IOLink.ImageView inputIntensityImage,
                string inputFilter = "",
                IOLink.ImageView outputLabelImage = null );

Class Syntax

// Command constructor.
LabelFiltering();

/// Gets the inputLabelImage parameter.
/// The label input image.
std::shared_ptr< iolink::ImageView > inputLabelImage() const;
/// Sets the inputLabelImage parameter.
/// The label input image.
void setInputLabelImage( std::shared_ptr< iolink::ImageView > inputLabelImage );

/// Gets the inputIntensityImage parameter.
/// The intensity input image. If it equals null, the label input image will be used as the intensity input image.
std::shared_ptr< iolink::ImageView > inputIntensityImage() const;
/// Sets the inputIntensityImage parameter.
/// The intensity input image. If it equals null, the label input image will be used as the intensity input image.
void setInputIntensityImage( std::shared_ptr< iolink::ImageView > inputIntensityImage );

/// Gets the inputFilter parameter.
/// The input filter formula.
std::string inputFilter() const;
/// Sets the inputFilter parameter.
/// The input filter formula.
void setInputFilter( const std::string& inputFilter );

/// Gets the outputLabelImage parameter.
/// The output label image. Its dimensions and type are forced to the same values as the input.
std::shared_ptr< iolink::ImageView > outputLabelImage() const;
/// Sets the outputLabelImage parameter.
/// The output label image. Its dimensions and type are forced to the same values as the input.
void setOutputLabelImage( std::shared_ptr< iolink::ImageView > outputLabelImage );


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

# Property of the inputLabelImage parameter.
LabelFiltering.input_label_image
# Property of the inputIntensityImage parameter.
LabelFiltering.input_intensity_image
# Property of the inputFilter parameter.
LabelFiltering.input_filter
# Property of the outputLabelImage parameter.
LabelFiltering.output_label_image

// Method to launch the command.
execute()

// Command constructor.
LabelFiltering()

// Property of the inputLabelImage parameter.
LabelFiltering.inputLabelImage
// Property of the inputIntensityImage parameter.
LabelFiltering.inputIntensityImage
// Property of the inputFilter parameter.
LabelFiltering.inputFilter
// Property of the outputLabelImage parameter.
LabelFiltering.outputLabelImage

// Method to launch the command.
Execute()

Parameters

	Description	Type	Supported Values	Default Value
inputLabelImage	The label input image.	Image	Label	nullptr
inputIntensityImage	The intensity input image. If it equals null, the label input image will be used as the intensity input image.	Image	Binary, Label, Grayscale or Multispectral	nullptr
inputFilter	The input filter formula. The Label Filtering section details how to create a filter.	Filter		""
outputLabelImage	The output label image. Its dimensions and type are forced to the same values as the input.	Image		nullptr

Description	Type	Supported Values	Default Value
input_label_image	The label input image.	image	Label	None
input_intensity_image	The intensity input image. If it equals null, the label input image will be used as the intensity input image.	image	Binary, Label, Grayscale or Multispectral	None
input_filter	The input filter formula. The Label Filtering section details how to create a filter.	filter		""
output_label_image	The output label image. Its dimensions and type are forced to the same values as the input.	image		None

Description	Type	Supported Values	Default Value
inputLabelImage	The label input image.	Image	Label	null
inputIntensityImage	The intensity input image. If it equals null, the label input image will be used as the intensity input image.	Image	Binary, Label, Grayscale or Multispectral	null
inputFilter	The input filter formula. The Label Filtering section details how to create a filter.	Filter		""
outputLabelImage	The output label image. Its dimensions and type are forced to the same values as the input.	Image		null

Object Examples

auto polystyrene_sep_label = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene_sep_label.vip" );
std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

LabelFiltering labelFilteringAlgo;
labelFilteringAlgo.setInputLabelImage( polystyrene_sep_label );
labelFilteringAlgo.setInputIntensityImage( polystyrene );
labelFilteringAlgo.setInputFilter( "Area>=3000" );
labelFilteringAlgo.execute();

std::cout << "outputLabelImage:" << labelFilteringAlgo.outputLabelImage()->toString();

polystyrene_sep_label = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep_label.vip"))
polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

label_filtering_algo = imagedev.LabelFiltering()
label_filtering_algo.input_label_image = polystyrene_sep_label
label_filtering_algo.input_intensity_image = polystyrene
label_filtering_algo.input_filter = "Area>=3000"
label_filtering_algo.execute()

print( "output_label_image:", str( label_filtering_algo.output_label_image ) )

ImageView polystyrene_sep_label = Data.ReadVipImage( @"Data/images/polystyrene_sep_label.vip" );
ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

LabelFiltering labelFilteringAlgo = new LabelFiltering
{
    inputLabelImage = polystyrene_sep_label,
    inputIntensityImage = polystyrene,
    inputFilter = "Area>=3000"
};
labelFilteringAlgo.Execute();

Console.WriteLine( "outputLabelImage:" + labelFilteringAlgo.outputLabelImage.ToString() );

Function Examples

auto polystyrene_sep_label = readVipImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene_sep_label.vip" );
std::shared_ptr< iolink::ImageView > polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

auto result = labelFiltering( polystyrene_sep_label, polystyrene, "Area>=3000" );

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

polystyrene_sep_label = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep_label.vip"))
polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

result = imagedev.label_filtering( polystyrene_sep_label, polystyrene, "Area>=3000" )

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

ImageView polystyrene_sep_label = Data.ReadVipImage( @"Data/images/polystyrene_sep_label.vip" );
ImageView polystyrene = ViewIO.ReadImage( @"Data/images/polystyrene.tif" );

IOLink.ImageView result = Processing.LabelFiltering( polystyrene_sep_label, polystyrene, "Area>=3000" );

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

LabelFiltering

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax