PasteImage2d

Pastes a two-dimensional image into another at a given location.

Access to parameter description

PasteImage2d pastes an area contained in an input image $I$ at a user-defined location of an output image $O$.
If the input image does not entirely fit into the output image at the given location, only the intersecting area is pasted, and no exception occurs.

See also

Function Syntax

This function returns outputImage.

// Function prototype
std::shared_ptr< iolink::ImageView >
pasteImage2d( std::shared_ptr< iolink::ImageView > inputSource,
              std::shared_ptr< iolink::ImageView > inputDestination,
              iolink::Vector2i32 originSource,
              iolink::Vector2i32 originDestination,
              iolink::Vector2u32 areaSize,
              std::shared_ptr< iolink::ImageView > outputImage = nullptr );

This function returns outputImage.

// Function prototype.
paste_image_2d(input_source: idt.ImageType,
               input_destination: idt.ImageType,
               origin_source: Iterable[int] = [0, 0],
               origin_destination: Iterable[int] = [0, 0],
               area_size: Iterable[int] = [0, 0],
               output_image: idt.ImageType = None) -> idt.ImageType

This function returns outputImage.

// Function prototype.
public static IOLink.ImageView
PasteImage2d( IOLink.ImageView inputSource,
              IOLink.ImageView inputDestination,
              int[] originSource = null,
              int[] originDestination = null,
              uint[] areaSize = null,
              IOLink.ImageView outputImage = null );

Class Syntax

// Command constructor.
PasteImage2d();

/// Gets the inputSource parameter.
/// The input source image to be pasted in the destination image.
std::shared_ptr< iolink::ImageView > inputSource() const;
/// Sets the inputSource parameter.
/// The input source image to be pasted in the destination image.
void setInputSource( std::shared_ptr< iolink::ImageView > inputSource );

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

/// Gets the originSource parameter.
/// The origin of the region to paste in the destination image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.
iolink::Vector2i32 originSource() const;
/// Sets the originSource parameter.
/// The origin of the region to paste in the destination image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.
void setOriginSource( const iolink::Vector2i32& originSource );

/// Gets the originDestination parameter.
/// The origin of the region to paste in the source image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.
iolink::Vector2i32 originDestination() const;
/// Sets the originDestination parameter.
/// The origin of the region to paste in the source image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.
void setOriginDestination( const iolink::Vector2i32& originDestination );

/// Gets the areaSize parameter.
/// The size of the region to select, in pixels.
iolink::Vector2u32 areaSize() const;
/// Sets the areaSize parameter.
/// The size of the region to select, in pixels.
void setAreaSize( const iolink::Vector2u32& areaSize );

/// Gets the outputImage parameter.
/// The output image where the input image is pasted. Its dimensions and type are forced to the same values as the destination input image.
std::shared_ptr< iolink::ImageView > outputImage() const;
/// Sets the outputImage parameter.
/// The output image where the input image is pasted. Its dimensions and type are forced to the same values as the destination input image.
void setOutputImage( std::shared_ptr< iolink::ImageView > outputImage );


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

# Property of the inputSource parameter.
PasteImage2d.input_source
# Property of the inputDestination parameter.
PasteImage2d.input_destination
# Property of the originSource parameter.
PasteImage2d.origin_source
# Property of the originDestination parameter.
PasteImage2d.origin_destination
# Property of the areaSize parameter.
PasteImage2d.area_size
# Property of the outputImage parameter.
PasteImage2d.output_image

// Method to launch the command.
execute()

// Command constructor.
PasteImage2d()

// Property of the inputSource parameter.
PasteImage2d.inputSource
// Property of the inputDestination parameter.
PasteImage2d.inputDestination
// Property of the originSource parameter.
PasteImage2d.originSource
// Property of the originDestination parameter.
PasteImage2d.originDestination
// Property of the areaSize parameter.
PasteImage2d.areaSize
// Property of the outputImage parameter.
PasteImage2d.outputImage

// Method to launch the command.
Execute()

Parameters

	Description	Type	Supported Values	Default Value
inputSource	The input source image to be pasted in the destination image.	Image	Binary, Label, Grayscale or Multispectral	nullptr
inputDestination	The input destination image.	Image	Binary, Label, Grayscale or Multispectral	nullptr
originSource	The origin of the region to paste in the destination image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	Vector2i32	Any value	{0, 0}
originDestination	The origin of the region to paste in the source image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	Vector2i32	Any value	{0, 0}
areaSize	The size of the region to select, in pixels. If this value is set to (0, 0), the full size of the source image is used. Only source pixels lying in the overlap between both input images (after translation of the source) are pasted in the destination.	Vector2u32	Any value	{0, 0}
outputImage	The output image where the input image is pasted. Its dimensions and type are forced to the same values as the destination input image.	Image		nullptr

	Description	Type	Supported Values	Default Value
input_source	The input source image to be pasted in the destination image.	image	Binary, Label, Grayscale or Multispectral	None
input_destination	The input destination image.	image	Binary, Label, Grayscale or Multispectral	None
origin_source	The origin of the region to paste in the destination image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	vector2i32	Any value	[0, 0]
origin_destination	The origin of the region to paste in the source image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	vector2i32	Any value	[0, 0]
area_size	The size of the region to select, in pixels. If this value is set to (0, 0), the full size of the source image is used. Only source pixels lying in the overlap between both input images (after translation of the source) are pasted in the destination.	vector2u32	Any value	[0, 0]
output_image	The output image where the input image is pasted. Its dimensions and type are forced to the same values as the destination input image.	image		None

	Description	Type	Supported Values	Default Value
inputSource	The input source image to be pasted in the destination image.	Image	Binary, Label, Grayscale or Multispectral	null
inputDestination	The input destination image.	Image	Binary, Label, Grayscale or Multispectral	null
originSource	The origin of the region to paste in the destination image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	Vector2i32	Any value	{0, 0}
originDestination	The origin of the region to paste in the source image, expressed in pixel coordinates. If the value is set outside the image, nothing is done.	Vector2i32	Any value	{0, 0}
areaSize	The size of the region to select, in pixels. If this value is set to (0, 0), the full size of the source image is used. Only source pixels lying in the overlap between both input images (after translation of the source) are pasted in the destination.	Vector2u32	Any value	{0, 0}
outputImage	The output image where the input image is pasted. Its dimensions and type are forced to the same values as the destination input image.	Image		null

Object Examples

auto polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

PasteImage2d pasteImage2dAlgo;
pasteImage2dAlgo.setInputSource( polystyrene );
pasteImage2dAlgo.setInputDestination( polystyrene );
pasteImage2dAlgo.setOriginSource( {0, 0} );
pasteImage2dAlgo.setOriginDestination( {10, 10} );
pasteImage2dAlgo.setAreaSize( {100, 100} );
pasteImage2dAlgo.execute();

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

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

paste_image_2d_algo = imagedev.PasteImage2d()
paste_image_2d_algo.input_source = polystyrene
paste_image_2d_algo.input_destination = polystyrene
paste_image_2d_algo.origin_source = [0, 0]
paste_image_2d_algo.origin_destination = [10, 10]
paste_image_2d_algo.area_size = [100, 100]
paste_image_2d_algo.execute()

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

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

PasteImage2d pasteImage2dAlgo = new PasteImage2d
{
    inputSource = polystyrene,
    inputDestination = polystyrene,
    originSource = new int[]{0, 0},
    originDestination = new int[]{10, 10},
    areaSize = new uint[]{100, 100}
};
pasteImage2dAlgo.Execute();

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

Function Examples

auto polystyrene = ioformat::readImage( std::string( IMAGEDEVDATA_IMAGES_FOLDER ) + "polystyrene.tif" );

auto result = pasteImage2d( polystyrene, polystyrene, {0, 0}, {10, 10}, {100, 100} );

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

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

result = imagedev.paste_image_2d(polystyrene, polystyrene, [0, 0], [10, 10], [100, 100])

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

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

IOLink.ImageView result = Processing.PasteImage2d( polystyrene, polystyrene, new int[]{0, 0}, new int[]{10, 10}, new uint[]{100, 100} );

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

PasteImage2d

- Function Syntax

+ Class Syntax

Parameters

Object Examples

Function Examples

Function Syntax

Class Syntax