cam.utilities.ocl_utils#

Fabex ‘ocl_utils.py’

Functions used by OpenCAMLib sampling.

Functions#

`pointSamplesFromOCL`(points, samples)	Update the z-coordinate of points based on corresponding sample values.
`chunkPointSamplesFromOCL`(chunks, samples)	Chunk point samples from OCL.
`chunkPointsResampleFromOCL`(chunks, samples)	Resample the Z values of points in chunks based on provided samples.
`exportModelsToSTL`(operation)	Export models to STL format.
`oclSamplePoints`(operation, points)	Sample points using an operation and process the results.
`oclSample`(operation, chunks)	Perform an operation on a set of chunks and process the resulting
`oclWaterlineLayerHeights`(operation)	Generate a list of waterline layer heights for a given operation.
`get_oclSTL`(operation)	Get the oclSTL representation from the provided operation.
`ocl_sample`(operation, chunks[, use_cached_mesh])	Sample points using a specified cutter and operation.

Module Contents#

pointSamplesFromOCL(points, samples)[source]#

Update the z-coordinate of points based on corresponding sample values.

This function iterates over a list of points and updates the z-coordinate of each point using the z value from the corresponding sample. The z value is scaled by a predefined constant, OCL_SCALE. It is assumed that the length of the points list matches the length of the samples list.

Parameters:

points (list) – A list of points, where each point is expected to be a list or array with at least three elements.
samples (list) – A list of sample objects, where each sample is expected to have a z attribute.

chunkPointSamplesFromOCL(chunks, samples)[source]#

Chunk point samples from OCL.

This function processes a list of chunks and corresponding samples, extracting the z-values from the samples and scaling them according to a predefined constant (OCL_SCALE). It sets the scaled z-values for each chunk based on the number of points in that chunk.

Parameters:

chunks (list) – A list of chunk objects that have a method count() and a method set_z().
samples (list) – A list of sample objects from which z-values are extracted.

chunkPointsResampleFromOCL(chunks, samples)[source]#

Resample the Z values of points in chunks based on provided samples.

This function iterates through a list of chunks and resamples the Z values of the points in each chunk using the corresponding samples. It first counts the number of points in each chunk, then extracts the Z values from the samples, scales them by a predefined constant (OCL_SCALE), and sets the resampled Z values back to the chunk.

Parameters:

chunks (list) – A list of chunk objects, each containing points that need to be resampled.
samples (list) – A list of sample objects from which Z values are extracted.

exportModelsToSTL(operation)[source]#

Export models to STL format.

This function takes an operation containing a collection of collision objects and exports each object as an STL file. It duplicates each object, applies transformations, and resizes them according to a predefined scale before exporting them to the temporary directory. The exported files are named sequentially as “model0.stl”, “model1.stl”, etc. After exporting, the function deletes the duplicated objects to clean up the scene.

Parameters:: operation – An object containing a collection of collision objects to be exported.

async oclSamplePoints(operation, points)[source]#

Sample points using an operation and process the results.

This asynchronous function takes an operation and a set of points, samples the points using the specified operation, and then processes the sampled points. The function relies on an external sampling function and a processing function to handle the sampling and post-processing of the data.

Parameters:

operation (str) – The operation to be performed on the points.
points (list) – A list of points to be sampled.

async oclSample(operation, chunks)[source]#

Perform an operation on a set of chunks and process the resulting samples.

This asynchronous function calls the ocl_sample function to obtain samples based on the provided operation and chunks. After retrieving the samples, it processes them using the chunkPointSamplesFromOCL function. This is useful for handling large datasets in a chunked manner, allowing for efficient sampling and processing.

Parameters:

operation (str) – The operation to be performed on the chunks.
chunks (list) – A list of data chunks to be processed.

Returns:

This function does not return a value.

Return type:

None

oclWaterlineLayerHeights(operation)[source]#

Generate a list of waterline layer heights for a given operation.

This function calculates the heights of waterline layers based on the specified parameters of the operation. It starts from the maximum height and decrements by a specified step until it reaches the minimum height. The resulting list of heights can be used for further processing in operations that require layered depth information.

Parameters:: operation (object) – An object containing the properties minz, maxz, and stepdown which define the minimum height, maximum height, and step size for layer generation, respectively.
Returns:: A list of waterline layer heights from maximum to minimum.
Return type:: list

get_oclSTL(operation)[source]#

Get the oclSTL representation from the provided operation.

This function iterates through the objects in the given operation and constructs an oclSTL object by extracting triangle data from mesh, curve, font, or surface objects. It activates each object and checks its type to determine if it can be processed. If no valid objects are found, it raises an exception.

Parameters:: operation (Operation) – An object containing a collection of objects
Returns:: An oclSTL object containing the triangles derived from the valid objects.
Return type:: ocl.STLSurf
Raises:: CamException – If no mesh, curve, or equivalent object is found in

async ocl_sample(operation, chunks, use_cached_mesh=False)[source]#

Sample points using a specified cutter and operation.

This function takes an operation and a list of chunks, and samples points based on the specified cutter type and its parameters. It supports various cutter types such as ‘END’, ‘BALLNOSE’, ‘VCARVE’, ‘CYLCONE’, ‘BALLCONE’, and ‘BULLNOSE’. The function can also utilize a cached mesh for efficiency. The sampled points are returned after processing all chunks.

Parameters:

operation (Operation) – An object containing the cutter type, diameter, minimum Z value, tip angle, and other relevant parameters.
chunks (list) – A list of chunk objects that contain point data to be processed.
use_cached_mesh (bool) – A flag indicating whether to use a cached mesh if available. Defaults to False.

Returns:

A list of sampled CL points generated by the cutter.

Return type:

list