IntensityHistogram

Computes the histogram of a gray level image.

Access to parameter description

For an introduction:

section Image Analysis
section Image Statistics

For each gray level

$i$ of the input image, the number of pixels with intensity

$i$ is computed.
This number of points per level is given in an histogram array. The histogram size depends on the intensity range. As an example, for an 8-bit integer image, the histogram

$H$ is an array with 256 entries.

$H(i)$ is the number of pixels at level i, for

$i \in [0,255]$ .

Notice: This algorithm can be used only on integer input images. The IntensityBinHistogram algorithm must be used to compute a histogram on floating point images.

See also

IntensityBinHistogram

Function Syntax

This function returns outputMeasurement.

// Function prototype
IntensityHistogramMsr::Ptr
intensityHistogram( std::shared_ptr< iolink::ImageView > inputImage,
                    IntensityHistogram::RangeMode rangeMode,
                    iolink::Vector2i32 intensityInputRange,
                    IntensityHistogramMsr::Ptr outputMeasurement = NULL );

This function returns outputMeasurement.

// Function prototype.
intensity_histogram( input_image,
                     range_mode = IntensityHistogram.RangeMode.MIN_MAX,
                     intensity_input_range = [0, 255],
                     output_measurement = None )

This function returns outputMeasurement.

// Function prototype.
public static IntensityHistogramMsr
IntensityHistogram( IOLink.ImageView inputImage,
                    IntensityHistogram.RangeMode rangeMode = ImageDev.IntensityHistogram.RangeMode.MIN_MAX,
                    int[] intensityInputRange = null,
                    IntensityHistogramMsr outputMeasurement = null );

Class Syntax

// Command constructor.
IntensityHistogram();

/// Gets the inputImage parameter.
/// The input gray scale image. Float images are not supported
std::shared_ptr< iolink::ImageView > inputImage() const;
/// Sets the inputImage parameter.
/// The input gray scale image. Float images are not supported
void setInputImage( std::shared_ptr< iolink::ImageView > inputImage );

/// Gets the rangeMode parameter.
/// The way to determine the input intensity range within which the histogram is computed.
IntensityHistogram::RangeMode rangeMode() const;
/// Sets the rangeMode parameter.
/// The way to determine the input intensity range within which the histogram is computed.
void setRangeMode( const IntensityHistogram::RangeMode& rangeMode );

/// Gets the intensityInputRange parameter.
/// The input intensity range [a,b] within which the histogram is computed. This parameter is ignored if the range mode is set to MIN_MAX.
iolink::Vector2i32 intensityInputRange() const;
/// Sets the intensityInputRange parameter.
/// The input intensity range [a,b] within which the histogram is computed. This parameter is ignored if the range mode is set to MIN_MAX.
void setIntensityInputRange( const iolink::Vector2i32& intensityInputRange );

/// Gets the outputMeasurement parameter.
/// The output histogram.
IntensityHistogramMsr::Ptr outputMeasurement() const;


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

# Property of the inputImage parameter.
IntensityHistogram.input_image
# Property of the rangeMode parameter.
IntensityHistogram.range_mode
# Property of the intensityInputRange parameter.
IntensityHistogram.intensity_input_range
# Property of the outputMeasurement parameter.
IntensityHistogram.output_measurement

// Method to launch the command.
execute()

// Command constructor.
IntensityHistogram()

// Property of the inputImage parameter.
IntensityHistogram.inputImage
// Property of the rangeMode parameter.
IntensityHistogram.rangeMode
// Property of the intensityInputRange parameter.
IntensityHistogram.intensityInputRange
// Property of the outputMeasurement parameter.
IntensityHistogram.outputMeasurement

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

inputImage

The input gray scale image. Float images are not supported

Image

Binary, Label, Grayscale or Multispectral

nullptr

rangeMode

The way to determine the input intensity range within which the histogram is computed.

MIN_MAX	This histogram is computed between the minimum and the maximum of the image.
OTHER	This histogram is computed between user-defined bounds [a,b].

Enumeration

MIN_MAX

intensityInputRange

The input intensity range [a,b] within which the histogram is computed. This parameter is ignored if the range mode is set to MIN_MAX.

Vector2i32

Any value

{0, 255}

outputMeasurement

The output histogram.

IntensityHistogramMsr

nullptr

Object Examples

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

IntensityHistogram intensityHistogramAlgo;
intensityHistogramAlgo.setInputImage( polystyrene );
intensityHistogramAlgo.setRangeMode( IntensityHistogram::RangeMode::MIN_MAX );
intensityHistogramAlgo.setIntensityInputRange( {0, 255} );
intensityHistogramAlgo.execute();

std::cout << "intensityValue: " << intensityHistogramAlgo.outputMeasurement()->intensityValue( 0 ) ;

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

intensity_histogram_algo = imagedev.IntensityHistogram()
intensity_histogram_algo.input_image = polystyrene
intensity_histogram_algo.range_mode = imagedev.IntensityHistogram.MIN_MAX
intensity_histogram_algo.intensity_input_range = [0, 255]
intensity_histogram_algo.execute()

print( "intensityValue: ", str( intensity_histogram_algo.output_measurement.intensity_value( 0 ) ) )

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

IntensityHistogram intensityHistogramAlgo = new IntensityHistogram
{
    inputImage = polystyrene,
    rangeMode = IntensityHistogram.RangeMode.MIN_MAX,
    intensityInputRange = new int[]{0, 255}
};
intensityHistogramAlgo.Execute();

Console.WriteLine( "intensityValue: " + intensityHistogramAlgo.outputMeasurement.intensityValue( 0 ) );

Function Examples

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

auto result = intensityHistogram( polystyrene, IntensityHistogram::RangeMode::MIN_MAX, {0, 255} );

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

polystyrene = ioformat.read_image(imagedev_data.get_image_path("polystyrene.tif"))

result = imagedev.intensity_histogram( polystyrene, imagedev.IntensityHistogram.MIN_MAX, [0, 255] )

print( "intensityValue: ", str( result.intensity_value( 0 ) )  )

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

IntensityHistogramMsr result = Processing.IntensityHistogram( polystyrene, IntensityHistogram.RangeMode.MIN_MAX, new int[]{0, 255} );

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

IntensityHistogram

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax