RandomSphereImage3d

Creates synthetic spheres in a binary image.

Access to parameter description

The RandomSphereImage3d algorithm creates a binary image containing a random distribution of spheres. The sphere radius range, distance, type of distribution, and number are parameters of the algorithm.

The following image is an example of the result with the default parameters:

<b>Figure 1.</b> Generation of 5 spheres

Figure 1. Generation of 5 spheres

See also

Function Syntax

This function returns outputBinaryImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
randomSphereImage3d( iolink::Vector3i32 imageSize,
                     int32_t sphereNumber,
                     RandomSphereImage3d::Distribution distribution,
                     iolink::Vector2i32 radiusRange,
                     int32_t distance,
                     std::shared_ptr< iolink::ImageView > outputBinaryImage = NULL );

This function returns outputBinaryImage.

// Function prototype.
random_sphere_image_3d( image_size = [100, 100, 100],
                        sphere_number = 5,
                        distribution = RandomSphereImage3d.Distribution.UNIFORM,
                        radius_range = [10, 20],
                        distance = 40,
                        output_binary_image = None )

This function returns outputBinaryImage.

// Function prototype.
public static IOLink.ImageView
RandomSphereImage3d( int[] imageSize = null,
                     Int32 sphereNumber = 5,
                     RandomSphereImage3d.Distribution distribution = ImageDev.RandomSphereImage3d.Distribution.UNIFORM,
                     int[] radiusRange = null,
                     Int32 distance = 40,
                     IOLink.ImageView outputBinaryImage = null );

Class Syntax

// Command constructor.
RandomSphereImage3d();

/// Gets the imageSize parameter.
/// The X, Y, and Z size in voxels of the output image.
iolink::Vector3i32 imageSize() const;
/// Sets the imageSize parameter.
/// The X, Y, and Z size in voxels of the output image.
void setImageSize( const iolink::Vector3i32& imageSize );

/// Gets the sphereNumber parameter.
/// The number of spheres to generate.
int32_t sphereNumber() const;
/// Sets the sphereNumber parameter.
/// The number of spheres to generate.
void setSphereNumber( const int32_t& sphereNumber );

/// Gets the distribution parameter.
/// The distribution type of the sphere radii.
RandomSphereImage3d::Distribution distribution() const;
/// Sets the distribution parameter.
/// The distribution type of the sphere radii.
void setDistribution( const RandomSphereImage3d::Distribution& distribution );

/// Gets the radiusRange parameter.
/// The minimum and maximum radius in voxels of the spheres (for Uniform distribution) or mean and standard deviation (for gaussian distribution).
iolink::Vector2i32 radiusRange() const;
/// Sets the radiusRange parameter.
/// The minimum and maximum radius in voxels of the spheres (for Uniform distribution) or mean and standard deviation (for gaussian distribution).
void setRadiusRange( const iolink::Vector2i32& radiusRange );

/// Gets the distance parameter.
/// The minimum distance between two sphere centers.
int32_t distance() const;
/// Sets the distance parameter.
/// The minimum distance between two sphere centers.
void setDistance( const int32_t& distance );

/// Gets the outputBinaryImage parameter.
/// The output 3D binary image.
std::shared_ptr< iolink::ImageView > outputBinaryImage() const;
/// Sets the outputBinaryImage parameter.
/// The output 3D binary image.
void setOutputBinaryImage( std::shared_ptr< iolink::ImageView > outputBinaryImage );


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

# Property of the imageSize parameter.
RandomSphereImage3d.image_size
# Property of the sphereNumber parameter.
RandomSphereImage3d.sphere_number
# Property of the distribution parameter.
RandomSphereImage3d.distribution
# Property of the radiusRange parameter.
RandomSphereImage3d.radius_range
# Property of the distance parameter.
RandomSphereImage3d.distance
# Property of the outputBinaryImage parameter.
RandomSphereImage3d.output_binary_image

// Method to launch the command.
execute()

// Command constructor.
RandomSphereImage3d()

// Property of the imageSize parameter.
RandomSphereImage3d.imageSize
// Property of the sphereNumber parameter.
RandomSphereImage3d.sphereNumber
// Property of the distribution parameter.
RandomSphereImage3d.distribution
// Property of the radiusRange parameter.
RandomSphereImage3d.radiusRange
// Property of the distance parameter.
RandomSphereImage3d.distance
// Property of the outputBinaryImage parameter.
RandomSphereImage3d.outputBinaryImage

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

imageSize

The X, Y, and Z size in voxels of the output image.

Vector3i32

{100, 100, 100}

sphereNumber

The number of spheres to generate.

Int32

>=1

distribution

The distribution type of the sphere radii.

UNIFORM	The radius distribution is uniform (each radius of the range has an equiprobability to occur).
GAUSSIAN	The radius distribution is Gaussian (the mean radius of the range is much more represented than the minimum and maximum radii).

Enumeration

UNIFORM

radiusRange

The minimum and maximum radius in voxels of the spheres (for Uniform distribution) or mean and standard deviation (for gaussian distribution).

Vector2i32

Any value

{10, 20}

distance

The minimum distance between two sphere centers.

Int32

>=0

outputBinaryImage

The output 3D binary image.

Image

nullptr

Object Examples


RandomSphereImage3d randomSphereImage3dAlgo;
randomSphereImage3dAlgo.setImageSize( {100, 100, 100} );
randomSphereImage3dAlgo.setSphereNumber( 5 );
randomSphereImage3dAlgo.setDistribution( RandomSphereImage3d::Distribution::UNIFORM );
randomSphereImage3dAlgo.setRadiusRange( {10, 20} );
randomSphereImage3dAlgo.setDistance( 40 );
randomSphereImage3dAlgo.execute();

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


random_sphere_image_3d_algo = imagedev.RandomSphereImage3d()
random_sphere_image_3d_algo.image_size = [100, 100, 100]
random_sphere_image_3d_algo.sphere_number = 5
random_sphere_image_3d_algo.distribution = imagedev.RandomSphereImage3d.UNIFORM
random_sphere_image_3d_algo.radius_range = [10, 20]
random_sphere_image_3d_algo.distance = 40
random_sphere_image_3d_algo.execute()

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


RandomSphereImage3d randomSphereImage3dAlgo = new RandomSphereImage3d
{
    imageSize = new int[]{100, 100, 100},
    sphereNumber = 5,
    distribution = RandomSphereImage3d.Distribution.UNIFORM,
    radiusRange = new int[]{10, 20},
    distance = 40
};
randomSphereImage3dAlgo.Execute();

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

Function Examples


auto result = randomSphereImage3d( {100, 100, 100}, 5, RandomSphereImage3d::Distribution::UNIFORM, {10, 20}, 40 );

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


result = imagedev.random_sphere_image_3d( [100, 100, 100], 5, imagedev.RandomSphereImage3d.UNIFORM, [10, 20], 40 )

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


IOLink.ImageView result = Processing.RandomSphereImage3d( new int[]{100, 100, 100}, 5, RandomSphereImage3d.Distribution.UNIFORM, new int[]{10, 20}, 40 );

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

RandomSphereImage3d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax