Inheritance diagram for XYZImage:

[legend]

Public Member Functions
	XYZImage (UndistortedImage undistortedDepthMap)
	Constructs a cartesian coordinate image from an undistorted depth map.

XYZImage	TransformToWorkspace (ExtrinsicParameters extrinsicParameters)
	Transforms the camera-centric coordinates into workspace coordinates.

void	Dispose ()
	Releases the resources used by the Image class.

void	ResetRegion ()
	Resets the region on the image to the complete image.

Image	Copy ()

Image	ConvertPixelFormat (PixelFormat pixelFormat)
	Converts the image to a different pixel format.

Image	ConvertPixelFormatWithFactor (PixelFormat pixelFormat, double factor)
	Converts an image into another pixel format with a factor multiplied to every pixel.

Image	Subtract (Image subtrahend)
	Subtracts the specified subtrahend image pixel-wise from the current image and returns the resulting image.

List< Image >	Deinterleave ()
	Splits an image with an interleaved pixel format into individual images. The function separates e.g. multiple exposures embedded in the combined HDR raw image and provides them as independent images, each with the correctly associated exposure information.

Static Public Member Functions
static Image	operator- (Image minuend, Image subtrahend)
	Performs pixel-wise subtraction of two images.

Properties
PixelFormat	PixelFormat `[get]`
	Gets the pixel format from the image.

Size	Size `[get]`
	Gets the image size in pixels from the image.

uint	Width `[get]`
	Gets the image width in pixels from the image.

uint	Height `[get]`
	Gets the image height in pixels from the image.

IntPtr	Data `[get]`
	Gets the image buffer from the image.

long	SizeInBytes `[get]`
	Gets the size of the image data in bytes.

Metadata	Metadata `[get, set]`
	Gets or sets the metadata of the image.

Region	Region `[get, set]`
	Gets or sets a region of interest (ROI) for the specified image handle, which defines a sub-area of the image where operations or analyses are focused. Any points in the region that fall outside the bounds of the image are automatically discarded (clipped).

static IEqualityComparer< Image >	Comparer = new ImageEqualityComparer() `[get]`
	Gets a default equality comparer for comparing Image data values.

Detailed Description

Represents a three-channel image encoding cartesian coordinates (x, y, z) of a 3D point.

This image is derived from an undistorted depth map that contains embedded intrinsic parameters and uses radial coordinates. In contrast to radial coordinates, which measure the direct distance from the optical center to the object, cartesian coordinates project these measurements onto a uniform plane. For example: If the camera faces a flat wall, only the cartesian coordinates will form a flat plane, whereas radial values will increase towards the image edges.

Since: IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ XYZImage()

XYZImage ( UndistortedImage undistortedDepthMap )

inline

Constructs a cartesian coordinate image from an undistorted depth map.

Supported pixel formats

Coord3D_C32f

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Parameters

undistortedDepthMap An image encoding radial distances to 3D points that contains embedded intrinsic camera parameters.

Since: IDSImaging.Peak.ICV 1.3

Member Function Documentation

◆ ConvertPixelFormat()

Image ConvertPixelFormat ( PixelFormat pixelFormat )

inlineinherited

Converts the image to a different pixel format.

If the input image has the same pixel format as the specified pixel format parameter, the image will be copied.

Restrictions:

Conversion to Bayer formats is only supported from a bayer format with the same pattern, e.g. from BayerRG10p to BayerRG10 or BayerRG8.
Conversion to packed formats is not supported.
Conversions from RGB or BGR formats to RGBa or BGRa formats is not supported.
RGBa and BGRa formats support only conversions into different bit depths of the same channel layout or to Mono formats.
Confidence and Coord3D formats can only be converted to other bit depths of the same format type.

Parameters

pixelFormat The target pixel format.

Returns: A new Image with the target pixel format.

For a full list of supported conversions see Supported Pixel Format Conversions.

Since: IDSImaging.Peak.ICV 1.3

◆ ConvertPixelFormatWithFactor()

Image ConvertPixelFormatWithFactor	(	PixelFormat	pixelFormat,
		double	factor )

inlineinherited

Converts an image into another pixel format with a factor multiplied to every pixel.

If the input image has the same pixel format as the specified pixel format parameter, the image will be copied.

Supported conversions:

From PixelFormat.Coord3D_C8 or PixelFormat.Coord3D_C16 to PixelFormat.Coord3D_C32f

Parameters

pixelFormat	The target pixel format.
factor	The multiplication factor.

Returns: A new image with the target pixel format.

Since: IDSImaging.Peak.ICV 1.3

◆ Copy()

Image Copy ( )

inlineinherited

Returns: A deep copy of the image, including its region and metadata.

Since: IDSImaging.Peak.ICV 1.3

◆ Deinterleave()

List< Image > Deinterleave ( )

inlineinherited

Splits an image with an interleaved pixel format into individual images. The function separates e.g. multiple exposures embedded in the combined HDR raw image and provides them as independent images, each with the correctly associated exposure information.

Supported pixel formats

Mono10g40IDS_I_A_B
BayerRG10g40IDS_I_A_B
BayerBG10g40IDS_I_A_B
BayerGR10g40IDS_I_A_B
BayerGB10g40IDS_I_A_B
Mono12g24IDS_I_A_B
BayerRG12g24IDS_I_A_B
BayerBG12g24IDS_I_A_B
BayerGR12g24IDS_I_A_B
BayerGB12g24IDS_I_A_B

Mono8_I_A_B
BayerRG8_I_A_B
BayerBG8_I_A_B
BayerGR8_I_A_B
BayerGB8_I_A_B
Mono10_I_A_B
BayerRG10_I_A_B
BayerBG10_I_A_B
BayerGR10_I_A_B
BayerGB10_I_A_B

Mono12_I_A_B
BayerRG12_I_A_B
BayerBG12_I_A_B
BayerGR12_I_A_B
BayerGB12_I_A_B
Mono10p_I_A_B
BayerRG10p_I_A_B
BayerBG10p_I_A_B
BayerGR10p_I_A_B
BayerGB10p_I_A_B

Mono12p_I_A_B
BayerRG12p_I_A_B
BayerBG12p_I_A_B
BayerGR12p_I_A_B
BayerGB12p_I_A_B
Mono8_I_AB_CD
Mono10_I_AB_CD
Mono12_I_AB_CD
Mono10p_I_AB_CD
Mono12p_I_AB_CD

Mono10g40IDS_I_AB_CD
Mono12g24IDS_I_AB_CD

See the Pixel and Pixel Format Specifications for a detailed description of the pixel formats.

Returns: A list of images, where each element represents one of the interleaved images.

Since: IDSImaging.Peak.ICV 1.3

◆ Dispose()

void Dispose ( )

inlineinherited

Releases the resources used by the Image class.

Since: IDSImaging.Peak.ICV 1.3

◆ operator-()

static Image operator-	(	Image	minuend,
		Image	subtrahend )

inlinestaticinherited

Performs pixel-wise subtraction of two images.

This operator performs a pixel-wise subtraction of subtrahend from minuend . Both images must have the same pixel format and dimensions.

Parameters

minuend	The image from which the subtrahend is subtracted.
subtrahend	The image to subtract from the minuend .

Returns: A new Image object representing the result of the subtraction.

Exceptions

IcvMismatchException The images have different dimensions or pixel formats.

Since: IDSImaging.Peak.ICV 1.3

◆ ResetRegion()

void ResetRegion ( )

inlineinherited

Resets the region on the image to the complete image.

Since: IDSImaging.Peak.ICV 1.3

◆ Subtract()

Image Subtract ( Image subtrahend )

inlineinherited

Subtracts the specified subtrahend image pixel-wise from the current image and returns the resulting image.

This function performs a pixelwise subtraction of the given subtrahend image from the current image. The resulting image is returned as a new Image object. The operation requires that both images have the same pixel format and dimensions.

Parameters

subtrahend The image to subtract from the current image.

Returns: The resulting image after pixel-wise subtraction.

Exceptions

IcvMismatchException Thrown if the images have different dimensions or pixel formats.

Since: IDSImaging.Peak.ICV 1.3

◆ TransformToWorkspace()

XYZImage TransformToWorkspace ( ExtrinsicParameters extrinsicParameters )

inline

Transforms the camera-centric coordinates into workspace coordinates.

This applies the inverse of the provided extrinsic matrix to map the 3D points from the camera's perspective into the physical workspace.

Parameters

extrinsicParameters The extrinsic parameters defining the workspace.

Since: IDSImaging.Peak.ICV 1.3

Property Documentation

◆ Comparer

IEqualityComparer<Image> Comparer = new ImageEqualityComparer()

staticgetinherited

Gets a default equality comparer for comparing Image data values.

Since: IDSImaging.Peak.ICV 1.3

◆ Data

IntPtr Data

getinherited

Gets the image buffer from the image.

Since: IDSImaging.Peak.ICV 1.3

◆ Height

uint Height

getinherited

Gets the image height in pixels from the image.

Since: IDSImaging.Peak.ICV 1.3

◆ Metadata

Metadata Metadata

getsetinherited

Gets or sets the metadata of the image.

Since: IDSImaging.Peak.ICV 1.3

◆ PixelFormat

PixelFormat PixelFormat

getinherited

Gets the pixel format from the image.

Since: IDSImaging.Peak.ICV 1.3

◆ Region

Region Region

getsetinherited

Gets or sets a region of interest (ROI) for the specified image handle, which defines a sub-area of the image where operations or analyses are focused. Any points in the region that fall outside the bounds of the image are automatically discarded (clipped).

Since: IDSImaging.Peak.ICV 1.3

◆ Size

Size Size

getinherited

Gets the image size in pixels from the image.

Since: IDSImaging.Peak.ICV 1.3

◆ SizeInBytes

long SizeInBytes

getinherited

Gets the size of the image data in bytes.

Since: IDSImaging.Peak.ICV 1.3

◆ Width

uint Width

getinherited

Gets the image width in pixels from the image.

Since: IDSImaging.Peak.ICV 1.3

Public Member Functions

Static Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ XYZImage()

Member Function Documentation

◆ ConvertPixelFormat()

Restrictions:

◆ ConvertPixelFormatWithFactor()

Supported conversions:

◆ Copy()

◆ Deinterleave()

◆ Dispose()

◆ operator-()

◆ ResetRegion()

◆ Subtract()

◆ TransformToWorkspace()

Property Documentation

◆ Comparer

◆ Data

◆ Height

◆ Metadata

◆ PixelFormat

◆ Region

◆ Size

◆ SizeInBytes

◆ Width