RadialGradientCentered2d

Performs a two-dimensional gradient projection with a directional vector defined by a center point.

Access to parameter description

For an introduction:

The RadialGradientCentered2d algorithm performs a gradient projection by computing the directional vector from a single given center. For all pixels

$P$ in the image, the projection is applied from the same user-defined center

$C$ .

Notices:

A common way to get input images $G_x$ and $G_y$ is to apply the Canny-Deriche operator in the X and Y directions, using GradientOperator2d with a spread of 60.
The projected resulting gradient image shown above is the Normal Gradient. Simultaneously, the tangential gradient could be computed with the ProjectionMode option GRADIENT_NORMAL_TANGENTIAL.

See also

Function Syntax

This function returns a RadialGradientCentered2dOutput structure containing outputNormalImage and outputTangentImage.

// Output structure of the radialGradientCentered2d function.
struct RadialGradientCentered2dOutput
{
    /// The normal gradient output image.
    std::shared_ptr< iolink::ImageView > outputNormalImage;
    /// The tangent gradient output image.
    std::shared_ptr< iolink::ImageView > outputTangentImage;
};

// Function prototype
RadialGradientCentered2dOutput
radialGradientCentered2d( std::shared_ptr< iolink::ImageView > inputImageX,
                          std::shared_ptr< iolink::ImageView > inputImageY,
                          iolink::Vector2i32 projectionCenter,
                          RadialGradientCentered2d::ProjectionMode projectionMode,
                          std::shared_ptr< iolink::ImageView > outputNormalImage = NULL,
                          std::shared_ptr< iolink::ImageView > outputTangentImage = NULL );

This function returns a tuple containing output_normal_image and output_tangent_image.

// Function prototype.
radial_gradient_centered_2d( input_image_x,
                             input_image_y,
                             projection_center = [1, 1],
                             projection_mode = RadialGradientCentered2d.ProjectionMode.GRADIENT_NORMAL,
                             output_normal_image = None,
                             output_tangent_image = None )

This function returns a RadialGradientCentered2dOutput structure containing outputNormalImage and outputTangentImage.

/// Output structure of the RadialGradientCentered2d function.
public struct RadialGradientCentered2dOutput
{
    /// The normal gradient output image.
    public IOLink.ImageView outputNormalImage;
    /// The tangent gradient output image.
    public IOLink.ImageView outputTangentImage;
};

// Function prototype.
public static RadialGradientCentered2dOutput
RadialGradientCentered2d( IOLink.ImageView inputImageX,
                          IOLink.ImageView inputImageY,
                          int[] projectionCenter = null,
                          RadialGradientCentered2d.ProjectionMode projectionMode = ImageDev.RadialGradientCentered2d.ProjectionMode.GRADIENT_NORMAL,
                          IOLink.ImageView outputNormalImage = null,
                          IOLink.ImageView outputTangentImage = null );

Class Syntax

// Command constructor.
RadialGradientCentered2d();

/// Gets the inputImageX parameter.
/// The X-gradient input image.
std::shared_ptr< iolink::ImageView > inputImageX() const;
/// Sets the inputImageX parameter.
/// The X-gradient input image.
void setInputImageX( std::shared_ptr< iolink::ImageView > inputImageX );

/// Gets the inputImageY parameter.
/// The Y-gradient input image.
std::shared_ptr< iolink::ImageView > inputImageY() const;
/// Sets the inputImageY parameter.
/// The Y-gradient input image.
void setInputImageY( std::shared_ptr< iolink::ImageView > inputImageY );

/// Gets the projectionCenter parameter.
/// The center of projection coordinates.
iolink::Vector2i32 projectionCenter() const;
/// Sets the projectionCenter parameter.
/// The center of projection coordinates.
void setProjectionCenter( const iolink::Vector2i32& projectionCenter );

/// Gets the projectionMode parameter.
/// The output images to be computed.
RadialGradientCentered2d::ProjectionMode projectionMode() const;
/// Sets the projectionMode parameter.
/// The output images to be computed.
void setProjectionMode( const RadialGradientCentered2d::ProjectionMode& projectionMode );

/// Gets the outputNormalImage parameter.
/// The normal gradient output image.
std::shared_ptr< iolink::ImageView > outputNormalImage() const;
/// Sets the outputNormalImage parameter.
/// The normal gradient output image.
void setOutputNormalImage( std::shared_ptr< iolink::ImageView > outputNormalImage );

/// Gets the outputTangentImage parameter.
/// The tangent gradient output image.
std::shared_ptr< iolink::ImageView > outputTangentImage() const;
/// Sets the outputTangentImage parameter.
/// The tangent gradient output image.
void setOutputTangentImage( std::shared_ptr< iolink::ImageView > outputTangentImage );


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

# Property of the inputImageX parameter.
RadialGradientCentered2d.input_image_x
# Property of the inputImageY parameter.
RadialGradientCentered2d.input_image_y
# Property of the projectionCenter parameter.
RadialGradientCentered2d.projection_center
# Property of the projectionMode parameter.
RadialGradientCentered2d.projection_mode
# Property of the outputNormalImage parameter.
RadialGradientCentered2d.output_normal_image
# Property of the outputTangentImage parameter.
RadialGradientCentered2d.output_tangent_image

// Method to launch the command.
execute()

// Command constructor.
RadialGradientCentered2d()

// Property of the inputImageX parameter.
RadialGradientCentered2d.inputImageX
// Property of the inputImageY parameter.
RadialGradientCentered2d.inputImageY
// Property of the projectionCenter parameter.
RadialGradientCentered2d.projectionCenter
// Property of the projectionMode parameter.
RadialGradientCentered2d.projectionMode
// Property of the outputNormalImage parameter.
RadialGradientCentered2d.outputNormalImage
// Property of the outputTangentImage parameter.
RadialGradientCentered2d.outputTangentImage

// Method to launch the command.
Execute()

Parameters

Parameter Name

Description

Type

Supported Values

Default Value

inputImageX

The X-gradient input image.

Image

Grayscale or Multispectral

nullptr

inputImageY

The Y-gradient input image.

Image

Grayscale or Multispectral

nullptr

projectionCenter

The center of projection coordinates.

Vector2i32

>=0

{1, 1}

projectionMode

The output images to be computed.

GRADIENT_NORMAL	The engine computes the normal gradient. Only the outputNormalImage output is set using this mode.
GRADIENT_NORMAL_TANGENTIAL	The engine computes the normal and tangential gradients. Both outputNormalImage and outputTangentImage outputs are set using this mode.

Enumeration

GRADIENT_NORMAL

outputNormalImage

The normal gradient output image.

Image

nullptr

outputTangentImage

The tangent gradient output image.

Image

nullptr

Object Examples

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

RadialGradientCentered2d radialGradientCentered2dAlgo;
radialGradientCentered2dAlgo.setInputImageX( polystyrene );
radialGradientCentered2dAlgo.setInputImageY( polystyrene );
radialGradientCentered2dAlgo.setProjectionCenter( {1, 1} );
radialGradientCentered2dAlgo.setProjectionMode( RadialGradientCentered2d::ProjectionMode::GRADIENT_NORMAL );
radialGradientCentered2dAlgo.execute();

std::cout << "outputNormalImage:" << radialGradientCentered2dAlgo.outputNormalImage()->toString();
std::cout << "outputTangentImage:" << radialGradientCentered2dAlgo.outputTangentImage()->toString();

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

radial_gradient_centered_2d_algo = imagedev.RadialGradientCentered2d()
radial_gradient_centered_2d_algo.input_image_x = polystyrene
radial_gradient_centered_2d_algo.input_image_y = polystyrene
radial_gradient_centered_2d_algo.projection_center = [1, 1]
radial_gradient_centered_2d_algo.projection_mode = imagedev.RadialGradientCentered2d.GRADIENT_NORMAL
radial_gradient_centered_2d_algo.execute()

print( "output_normal_image:", str( radial_gradient_centered_2d_algo.output_normal_image ) )
print( "output_tangent_image:", str( radial_gradient_centered_2d_algo.output_tangent_image ) )

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

RadialGradientCentered2d radialGradientCentered2dAlgo = new RadialGradientCentered2d
{
    inputImageX = polystyrene,
    inputImageY = polystyrene,
    projectionCenter = new int[]{1, 1},
    projectionMode = RadialGradientCentered2d.ProjectionMode.GRADIENT_NORMAL
};
radialGradientCentered2dAlgo.Execute();

Console.WriteLine( "outputNormalImage:" + radialGradientCentered2dAlgo.outputNormalImage.ToString() );
Console.WriteLine( "outputTangentImage:" + radialGradientCentered2dAlgo.outputTangentImage.ToString() );

Function Examples

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

auto result = radialGradientCentered2d( polystyrene, polystyrene, {1, 1}, RadialGradientCentered2d::ProjectionMode::GRADIENT_NORMAL );

std::cout << "outputNormalImage:" << result.outputNormalImage->toString();
std::cout << "outputTangentImage:" << result.outputTangentImage->toString();

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

result_output_normal_image, result_output_tangent_image = imagedev.radial_gradient_centered_2d( polystyrene, polystyrene, [1, 1], imagedev.RadialGradientCentered2d.GRADIENT_NORMAL )

print( "output_normal_image:", str( result_output_normal_image ) )
print( "output_tangent_image:", str( result_output_tangent_image ) )

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

Processing.RadialGradientCentered2dOutput result = Processing.RadialGradientCentered2d( polystyrene, polystyrene, new int[]{1, 1}, RadialGradientCentered2d.ProjectionMode.GRADIENT_NORMAL );

Console.WriteLine( "outputNormalImage:" + result.outputNormalImage.ToString() );
Console.WriteLine( "outputTangentImage:" + result.outputTangentImage.ToString() );

RadialGradientCentered2d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax