TotalImageVolume

Measures the volume of interest of a binary image.

Access to parameter description

For an introduction:

section Image Analysis
section Morphometry

This algorithm measures the volume of interest

$TV$ of an image.
On a 2D image, this measurement is more precisely an area, and has dimension 2. On a 3D image, it corresponds to a volume and has dimension 3.
If no mask is provided, it corresponds to the total volume of the input image. If a mask is provided, it corresponds to the volume of the mask image.

Usage without a mask

On a 2D image $TV = gx \times cx \times gy \times cy$
On a 3D image $TV = gx \times cx \times gy \times cy \times gy \times cy \times gz \times cz \times gx \times cx \times gz \times cz$

where

gx, gy and gz represent the image size in pixel coordinates along the X, Y, and Z axes respectively.
cx, cy and cz represent the image calibration spacing in world coordinates along the X, Y, and Z axes.

Usage with a mask

On a 2D image $TV = Ar(M)$
On a 3D image $TV = V(M)$

where

$M$ is the binary mask image.
$Ar$ is the 2D area given by the Area2d algorithm.
$V$ is the 3D volume given by the IntensityIntegral3d algorithm in the binary case.

See also

Function Syntax

This function returns outputMeasurement.

// Function prototype
ImageVolumeMsr::Ptr
totalImageVolume( std::shared_ptr< iolink::ImageView > inputImage,
                  std::shared_ptr< iolink::ImageView > inputMaskImage,
                  ImageVolumeMsr::Ptr outputMeasurement = NULL );

This function returns outputMeasurement.

// Function prototype.
total_image_volume( input_image, input_mask_image, output_measurement = None )

This function returns outputMeasurement.

// Function prototype.
public static ImageVolumeMsr
TotalImageVolume( IOLink.ImageView inputImage,
                  IOLink.ImageView inputMaskImage,
                  ImageVolumeMsr outputMeasurement = null );

Class Syntax

// Command constructor.
TotalImageVolume();

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

/// Gets the inputMaskImage parameter.
/// The binary image defining the volume of interest. The measurement is computed from voxels having a value of 1 in this image. If it equals null, the computation is performed from all voxels 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 voxels having a value of 1 in this image. If it equals null, the computation is performed from all voxels 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.
ImageVolumeMsr::Ptr outputMeasurement() const;


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

# Property of the inputImage parameter.
TotalImageVolume.input_image
# Property of the inputMaskImage parameter.
TotalImageVolume.input_mask_image
# Property of the outputMeasurement parameter.
TotalImageVolume.output_measurement

// Method to launch the command.
execute()

// Command constructor.
TotalImageVolume()

// Property of the inputImage parameter.
TotalImageVolume.inputImage
// Property of the inputMaskImage parameter.
TotalImageVolume.inputMaskImage
// Property of the outputMeasurement parameter.
TotalImageVolume.outputMeasurement

// Method to launch the command.
Execute()

Parameters

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

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

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

Object Examples

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

TotalImageVolume totalImageVolumeAlgo;
totalImageVolumeAlgo.setInputImage( polystyrene );
totalImageVolumeAlgo.setInputMaskImage( polystyrene_mask );
totalImageVolumeAlgo.execute();

std::cout << "pixelCount: " << totalImageVolumeAlgo.outputMeasurement()->pixelCount( 0 ) ;

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

total_image_volume_algo = imagedev.TotalImageVolume()
total_image_volume_algo.input_image = polystyrene
total_image_volume_algo.input_mask_image = polystyrene_mask
total_image_volume_algo.execute()

print( "pixelCount: ", str( total_image_volume_algo.output_measurement.pixel_count( 0 ) ) )

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

TotalImageVolume totalImageVolumeAlgo = new TotalImageVolume
{
    inputImage = polystyrene,
    inputMaskImage = polystyrene_mask
};
totalImageVolumeAlgo.Execute();

Console.WriteLine( "pixelCount: " + totalImageVolumeAlgo.outputMeasurement.pixelCount( 0 ) );

Function Examples

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

auto result = totalImageVolume( polystyrene, polystyrene_mask );

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

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

result = imagedev.total_image_volume( polystyrene, polystyrene_mask )

print( "pixelCount: ", str( result.pixel_count( 0 ) )  )

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

ImageVolumeMsr result = Processing.TotalImageVolume( polystyrene, polystyrene_mask );

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

TotalImageVolume

Usage without a mask

Usage with a mask

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax