IDS peak ICV v1.5.0
Loading...
Searching...
No Matches
PointCloudXYZ Class Reference
Inheritance diagram for PointCloudXYZ:

Public Member Functions

 PointCloudXYZ (XYZImage image)
 Constructs a point cloud from the specified XYZ image.
 
 PointCloudXYZ (UndistortedImage undistortedDepthMap)
 Constructs a point cloud from the specified undistorted depth map.
 
 PointCloudXYZ (string filePath)
 Constructs a point cloud by loading it from the specified file.
 
 PointCloudXYZ (PointXYZ[] points)
 Constructs a point cloud from the specified collection of points.
 
PointCloudXYZ Transform (TransformationMatrix3D matrix)
 Applies a transformation to the point cloud.
 
PointCloudXYZ TransformToWorkspace (ExtrinsicParameters extrinsicParameters)
 Transforms the point cloud to the workspace coordinate system using the extrinsic parameters.
 
override string ToString ()
 Returns a string representation of the point cloud.
 

Properties

override PointXYZ[] Points [get]
 
static IEqualityComparer< PointCloudXYZ > Comparer = new PointCloudEqualityComparer() [get]
 Gets a default equality comparer for comparing PointCloudXYZ data values.
 

Detailed Description

Represents a point cloud consisting of points with x, y, and z coordinates.

Since
IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ PointCloudXYZ() [1/4]

PointCloudXYZ ( XYZImage image)
inline

Constructs a point cloud from the specified XYZ image.

Parameters
imageImage containing x, y, and z coordinates per pixel.
Exceptions
IcvNotSupportedExceptionThe image format is not supported.
Since
IDSImaging.Peak.ICV 1.3

◆ PointCloudXYZ() [2/4]

PointCloudXYZ ( UndistortedImage undistortedDepthMap)
inline

Constructs a point cloud from the specified undistorted depth map.

The intrinsic parameters must be embedded in the image. The depth values must represent distances measured in a spherical coordinate system centered at the camera origin. Each pixel must encode the radial distance to a 3D point. Use the Undistortion class to convert a distorted depth map into an UndistortedImage.

Parameters
undistortedDepthMapImage containing distance values per pixel, along with intrinsic camera parameters.
Exceptions
IcvNotSupportedExceptionThe image format is not supported.
Since
IDSImaging.Peak.ICV 1.3

◆ PointCloudXYZ() [3/4]

PointCloudXYZ ( string filePath)
inline

Constructs a point cloud by loading it from the specified file.

The file format is determined by the specified file extension of the file name. Supported file formats (with required file extensions):

  • PLY (.ply) – Polygon File Format.
Parameters
filePathPath to the point cloud file.
Exceptions
IcvIOExceptionThe specified filePath is invalid or lacks read permissions, or the file is in an unsupported format or contains invalid data.
Since
IDSImaging.Peak.ICV 1.3

◆ PointCloudXYZ() [4/4]

PointCloudXYZ ( PointXYZ[] points)
inline

Constructs a point cloud from the specified collection of points.

Parameters
pointsCollection of 3D points.
Since
IDSImaging.Peak.ICV 1.3

Member Function Documentation

◆ ToString()

override string ToString ( )
inlineinherited

Returns a string representation of the point cloud.

Since
IDSImaging.Peak.ICV 1.3

◆ Transform()

PointCloudXYZ Transform ( TransformationMatrix3D matrix)
inline

Applies a transformation to the point cloud.

Parameters
matrixThe transformation matrix.
Returns
A new transformed point cloud.
Since
IDSImaging.Peak.ICV 1.3

◆ TransformToWorkspace()

PointCloudXYZ TransformToWorkspace ( ExtrinsicParameters extrinsicParameters)
inline

Transforms the point cloud to the workspace coordinate system using the extrinsic parameters.

Parameters
extrinsicParametersExtrinsic parameters of the workspace calibration.
Returns
A new transformed point cloud.
Since
IDSImaging.Peak.ICV 1.3

Property Documentation

◆ Comparer

IEqualityComparer<PointCloudXYZ> Comparer = new PointCloudEqualityComparer()
staticget

Gets a default equality comparer for comparing PointCloudXYZ data values.

Since
IDSImaging.Peak.ICV 1.3

◆ Points

override PointXYZ [] Points
get