# WritePointCloud

The WritePointCloud function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. is used to save the acquired point cloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition. acquisitions into Filmstrip files, even when the vision system is Online. The function lets you save the acquired point cloud data onto:

- The internal storage of the vision system
- A remote FTP server
- A remote SFTP server

You can load the saved point cloud data into the Filmstrip with the appropriate Filmstrip controls.

Inputs

The WritePointCloud function has the following syntax:

WritePointCloud(PointCloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition.,Event,Storage,Server,UserName,Password,FilePath,FileName,AppendMode,MaxAppendValue,Reset)

Parameter | Description
PointCloud | Reference to a cell containing a point cloud. The default value is $A$0.
Event | Specifies an external event forcing In-Sight Spreadsheet to save the acquired point cloud. This can be an Event structure or a Button function. Tip: If no changes are made to this parameter, the function automatically creates and references a Write Button on the spreadsheet.
Storage | Specifies the storage where the saved point clouds are stored: Local Device: The acquired point cloud data is saved to the internal storage of the vision system. FTP Server: The acquired point cloud data is saved onto the specified remote FTP storage. This is the default setting. SFTP Server: The acquired point cloud data is saved onto the specified remote SFTP storage.
Server | Specifies the valid IP address of the FTP server in an IPAddress:PortNumber format (e.g. 99.99.99.99:1234). Note: This parameter is enabled only if Storage is set to FTP Server or SFTP Server.
User Name | Specifies a valid login username for the FTP server. Note: This parameter is enabled only if Storage is set to FTP Server or SFTP Server.
Password | Specifies a valid login password for the FTP server. Note: This parameter is enabled only if Storage is set to FTP Server or SFTP Server.
File Path | Specifies the location where the point cloud data will be saved. Note: When saving data to the vision system's internal storage, this parameter defaults to the device's root directory. When saving data to an FTP server or SFTP server, provide the full path of the directory.
File Name | Specifies the file name of the saved point cloud data. The specified suffix (configured with Append Mode) will be appended to this file name for all saved point cloud data file. Tip: Do not specify the file extension.
Append Mode | Specifies the type of information appended to the file name when saving point cloud data: Index: The function will append the acquisition Acquisition is the process or result of the vision system acquiring a new image. index number to the file name. This is the default setting. Timestamp: The function will append the acquisition timestamp to the file name.
Max. Append Value | Specifies the highest index value that the function can append to the file name. Once this value is reached, the index numbering will restart with the next acquisition, overwriting the saved files with the same name. Note: The value range is 0 - 9999999. Specifying a value outside this range (such as -1) will result in no suffixes appended to the file names. This parameter is enabled only if Append Mode is set to Index.
Reset | When enabled, it resets point cloud writing at the next Event. Tip: If no changes are made to this parameter, the function will automatically create and reference a Reset Button on the spreadsheet.

Outputs

Returns | A ❒WritePointCloud function, along with a default set of Write and Reset buttons (if using the default values of the Event and Reset parameters).
Results | Once inserted into a cell with the default settings, click the Write button to save the currently acquired point cloud, or click Reset to reset the save event.