ObjectBoundaryArea

Measures the surface of objects contained in the volume of interest of a binary image.

Access to parameter description

For an introduction:

section Image Analysis
section Morphometry

This algorithm measures the surface area $S$ of solid objects.

On a 2D image, it returns the Crofton Perimeter, which is homogeneous to a length (dimensionality 1).
On a 3D image, it returns the result of the Area3d algorithm, which is homogeneous to a surface (dimensionality 2).

This algorithm takes into account the input image calibration (spacing) and returns thus results in world coordinates.

See also

Function Syntax

This function returns outputMeasurement.

// Function prototype
ObjectBoundaryAreaMsr::Ptr
objectBoundaryArea( std::shared_ptr< iolink::ImageView > inputBinaryImage,
                    std::shared_ptr< iolink::ImageView > inputMaskImage,
                    ObjectBoundaryAreaMsr::Ptr outputMeasurement = nullptr );

This function returns outputMeasurement.

// Function prototype.
object_boundary_area(input_binary_image: idt.ImageType,
                     input_mask_image: idt.ImageType,
                     output_measurement: Union[Any, None] = None) -> ObjectBoundaryAreaMsr

This function returns outputMeasurement.

// Function prototype.
public static ObjectBoundaryAreaMsr
ObjectBoundaryArea( IOLink.ImageView inputBinaryImage,
                    IOLink.ImageView inputMaskImage,
                    ObjectBoundaryAreaMsr outputMeasurement = null );

Class Syntax

// Command constructor.
ObjectBoundaryArea();

/// Gets the inputBinaryImage parameter.
/// The input binary image.
std::shared_ptr< iolink::ImageView > inputBinaryImage() const;
/// Sets the inputBinaryImage parameter.
/// The input binary image.
void setInputBinaryImage( std::shared_ptr< iolink::ImageView > inputBinaryImage );

/// Gets the inputMaskImage parameter.
/// The binary image defining the volume of interest. The measurement is computed from pixels having a 1 value in this image. If it equals null, the computation is performed from all pixels of the input image. It must have same dimensions as the input image.
std::shared_ptr< iolink::ImageView > inputMaskImage() const;
/// Sets the inputMaskImage parameter.
/// The binary image defining the volume of interest. The measurement is computed from pixels having a 1 value in this image. If it equals null, the computation is performed from all pixels of the input image. It must have same dimensions as the input image.
void setInputMaskImage( std::shared_ptr< iolink::ImageView > inputMaskImage );

/// Gets the outputMeasurement parameter.
/// The output measurement result.
ObjectBoundaryAreaMsr::Ptr outputMeasurement() const;


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

# Property of the inputBinaryImage parameter.
ObjectBoundaryArea.input_binary_image
# Property of the inputMaskImage parameter.
ObjectBoundaryArea.input_mask_image
# Property of the outputMeasurement parameter.
ObjectBoundaryArea.output_measurement

// Method to launch the command.
execute()

// Command constructor.
ObjectBoundaryArea()

// Property of the inputBinaryImage parameter.
ObjectBoundaryArea.inputBinaryImage
// Property of the inputMaskImage parameter.
ObjectBoundaryArea.inputMaskImage
// Property of the outputMeasurement parameter.
ObjectBoundaryArea.outputMeasurement

// Method to launch the command.
Execute()

Parameters

	Description	Type	Supported Values	Default Value
inputBinaryImage	The input binary image.	Image	Binary	nullptr
inputMaskImage	The binary image defining the volume of interest. The measurement is computed from pixels having a 1 value in this image. If it equals null, the computation is performed from all pixels of the input image. It must have same dimensions as the input image.	Image	Binary	nullptr
outputMeasurement	The output measurement result.	ObjectBoundaryAreaMsr		nullptr

	Description	Type	Supported Values	Default Value
input_binary_image	The input binary image.	image	Binary	None
input_mask_image	The binary image defining the volume of interest. The measurement is computed from pixels having a 1 value in this image. If it equals null, the computation is performed from all pixels of the input image. It must have same dimensions as the input image.	image	Binary	None
output_measurement	The output measurement result.	ObjectBoundaryAreaMsr		None

	Description	Type	Supported Values	Default Value
inputBinaryImage	The input binary image.	Image	Binary	null
inputMaskImage	The binary image defining the volume of interest. The measurement is computed from pixels having a 1 value in this image. If it equals null, the computation is performed from all pixels of the input image. It must have same dimensions as the input image.	Image	Binary	null
outputMeasurement	The output measurement result.	ObjectBoundaryAreaMsr		null

Object Examples

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

ObjectBoundaryArea objectBoundaryAreaAlgo;
objectBoundaryAreaAlgo.setInputBinaryImage( polystyrene_sep );
objectBoundaryAreaAlgo.setInputMaskImage( polystyrene_mask );
objectBoundaryAreaAlgo.execute();

std::cout << "surface: " << objectBoundaryAreaAlgo.outputMeasurement()->surface( 0 ) ;

polystyrene_sep = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep.vip"))
polystyrene_mask = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_mask.vip"))

object_boundary_area_algo = imagedev.ObjectBoundaryArea()
object_boundary_area_algo.input_binary_image = polystyrene_sep
object_boundary_area_algo.input_mask_image = polystyrene_mask
object_boundary_area_algo.execute()

print("surface: ", str(object_boundary_area_algo.output_measurement.surface(0)))

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

ObjectBoundaryArea objectBoundaryAreaAlgo = new ObjectBoundaryArea
{
    inputBinaryImage = polystyrene_sep,
    inputMaskImage = polystyrene_mask
};
objectBoundaryAreaAlgo.Execute();

Console.WriteLine( "surface: " + objectBoundaryAreaAlgo.outputMeasurement.surface( 0 ) );

Function Examples

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

auto result = objectBoundaryArea( polystyrene_sep, polystyrene_mask );

std::cout << "surface: " << result->surface( 0 ) ;

polystyrene_sep = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_sep.vip"))
polystyrene_mask = imagedev.read_vip_image(imagedev_data.get_image_path("polystyrene_mask.vip"))

result = imagedev.object_boundary_area(polystyrene_sep, polystyrene_mask)

print("surface: ", str(result.surface(0)))

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

ObjectBoundaryAreaMsr result = Processing.ObjectBoundaryArea( polystyrene_sep, polystyrene_mask );

Console.WriteLine(  "surface: " + result.surface( 0 )  );

ObjectBoundaryArea

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax