ImageDev

BoxGridImage3d

Creates a new three-dimensional image containing a binary or labeled grid.

Access to parameter description

This algorithm generates a new binary or label image containing a rectangular pattern that can be presented as:
<b> (a) </b>
(a)
<b> (b) </b>
(b)
Figure 1. Generation of a 3D box grid image (a) in contiguous region mode and (b) in lines mode

See also

Function Syntax

This function returns the outputImage output parameter. 
// Function prototype.
std::shared_ptr< iolink::ImageView >
boxGridImage3d( BoxGridImage3d::OutputType outputType,
                iolink::Vector3u32 imageSize,
                iolink::Vector3u32 origin,
                iolink::Vector3u32 gridOffset,
                std::shared_ptr< iolink::ImageView > outputImage = NULL );
This function returns the outputImage output parameter. 
// Function prototype.
box_grid_image_3d( output_type = BoxGridImage3d.OutputType.LINES,
                   image_size = [128, 128, 128],
                   origin = [0, 0, 0],
                   grid_offset = [10, 10, 10],
                   output_image = None )
This function returns the outputImage output parameter. 
// Function prototype.
public static IOLink.ImageView
BoxGridImage3d( BoxGridImage3d.OutputType outputType = ImageDev.BoxGridImage3d.OutputType.LINES,
                uint[] imageSize = null,
                uint[] origin = null,
                uint[] gridOffset = null,
                IOLink.ImageView outputImage = null );

Class Syntax

Parameters

Class Name BoxGridImage3d

Parameter Name Description Type Supported Values Default Value
input
outputType
OutputType defines the type of desired grid in the output image.
LINES The output image contains a binary grid.
CONTIGUOUS_REGIONS The output image contains a grid of connected labels.
SEPARATED_REGIONS The output image contains a grid of separated labels.
Enumeration LINES
input
imageSize
The dimensions, in pixels, of the output image. Vector3u32 != 0 {128, 128, 128}
input
origin
The origin of the first full rectangular region to generate. Vector3u32 Any value {0, 0, 0}
input
gridOffset
The X, Y, and Z side size of boxes to create in the output images. In CONTIGUOUS_REGIONS or SEPARATED_REGIONS mode, it represents the number of pixels between the top left corners of contiguous labels in each direction. In LINES mode, it represents the offset, in pixels, between consecutive lines in each direction. Vector3u32 != 0 {10, 10, 10}
output
outputImage
The output 3d image containing the grid. Type depends of the type of the grid. Image nullptr

Object Examples


BoxGridImage3d boxGridImage3dAlgo;
boxGridImage3dAlgo.setOutputType( BoxGridImage3d::OutputType::LINES );
boxGridImage3dAlgo.setImageSize( {128, 128, 128} );
boxGridImage3dAlgo.setOrigin( {0, 0, 0} );
boxGridImage3dAlgo.setGridOffset( {10, 10, 10} );
boxGridImage3dAlgo.execute();

std::cout << "outputImage:" << boxGridImage3dAlgo.outputImage()->toString();


box_grid_image_3d_algo = imagedev.BoxGridImage3d()
box_grid_image_3d_algo.output_type = imagedev.BoxGridImage3d.LINES
box_grid_image_3d_algo.image_size = [128, 128, 128]
box_grid_image_3d_algo.origin = [0, 0, 0]
box_grid_image_3d_algo.grid_offset = [10, 10, 10]
box_grid_image_3d_algo.execute()

print( "output_image:", str( box_grid_image_3d_algo.output_image ) )


BoxGridImage3d boxGridImage3dAlgo = new BoxGridImage3d
{
    outputType = BoxGridImage3d.OutputType.LINES,
    imageSize = new uint[]{128, 128, 128},
    origin = new uint[]{0, 0, 0},
    gridOffset = new uint[]{10, 10, 10}
};
boxGridImage3dAlgo.Execute();

Console.WriteLine( "outputImage:" + boxGridImage3dAlgo.outputImage.ToString() );

Function Examples


auto result = boxGridImage3d( BoxGridImage3d::OutputType::LINES, {128, 128, 128}, {0, 0, 0}, {10, 10, 10} );

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


result = imagedev.box_grid_image_3d( imagedev.BoxGridImage3d.LINES, [128, 128, 128], [0, 0, 0], [10, 10, 10] )

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


IOLink.ImageView result = Processing.BoxGridImage3d( BoxGridImage3d.OutputType.LINES, new uint[]{128, 128, 128}, new uint[]{0, 0, 0}, new uint[]{10, 10, 10} );

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