uffutils 0.5.1

A set of commandline tools for manipulating UFF files.

UFFUtils

A Python-based command-line tool for manipulating UFF datasets.

Introduction

UFFUtils lets you inspect and manipulate UFF files. Let's look at an example.

Say you have some dataset - my_data.uff - that you want to reduce in size (e.g., by only taking every 1000th node), scale from mm to m, rotate around the y-axis by 90 degrees. With UFFUtils, you would do this in the following way:

uffutils subset my_data.uff --step 1000 `
uffutils scale --length 0.001 `
uffutils rotate - rotated.uff --angles 0 90 0

Congratulations! You now have a reduced, scaled and rotated version of your dataset!

For more functionality, see the description of each command below.

Installing

A good way to run UFF utils is through uv. Once you have installed uv, you can run uffutils like so:

uvx uffutils

No need for any additional software (e.g., Python); uv handles it for you.

Usage

The inspect command

The inspect command allows you to view the contents of a UFF file. Example usage:

uffutils inspect my_file.uff  # Print nice overview 
uffutils inspect my_file.uff --nodes # Print full list of nodes

The subset command

Allows you to create file with a subset of nodes, which is particularly useful if you want to downsize a UFF file. Usage:

uffutils subset input.uff output.uff --ids "1,2,3"  # Only takes nodes 1, 2 and 3
uffutils subset input.uff output.uff --step 1000  # Takes every 1000th node, starting at 1 
uffutils subset input.uff output.uff --max 100 # Takes the first 100 nodes 

Operations can be combined. The following operation yields a file with nodes 10 and 30.

uffutils subset input.uff output.uff --selection "10,20,30,40,50" --step 2 --max 2

The scale command

You can scale length:

uffutils scale input.uff output.uff --length 1000 

The move command

You can translate the data:

uffutils move input.uff output.uff --xyz 10.0 20.0 30.0 

The rotate command

You can rotate the data:

uffutils rotate input.uff output.uff --angles 90 90 90

Combining commands

You can combine commands through piping, like so:

uffutils subset input.uff --step 100 | `
    uffutils scale --length 1000 | `
    uffutils move --xyz 10 20 30 | `
    uffutils rotate - output.uff --xyz 90 0 0