Houdini 19.0 Nodes TOP nodes

File Compress TOP node

Compress files into an archive.

On this page
Since 17.5

This node generates a work item for each incoming work item that takes all file results tagged file and compiles them into a compressed archive. The output result of each work item is the archive file.

TOP Attributes

method

string

The compression method (for example, "zip" or "tar.gz").

output_file

string

File path to the output archive file.

input_files

string

Array of path strings representing the source files compiled into the archive.

Parameters

Node

Mode

How do decide what file(s) to compress:

Custom File Path

Set the path to the file to compress in the File Path parameter.

Upstream Output Files

Compress any file paths in the output attributes of incoming work items if they have the given file tag.

File To Compress

When Mode is “Custom File Path”, the path of the file to be compressed.

File Tag

When Mode is “Upstream Output Files”, compress paths in the output attributes of incoming work items if they have this file tag.

Compression Method

The archive method/format, ZIP or tar.gz.

Output File

Specify the file path of the generated archive file. The file extension will be added if not specified.

Compress Archive

When Compression Method is set to ZIP, this parameter determines whether or not the .zip archive is compressed.

Append to Existing Archive

When Compression Method is set to ZIP, this parameter determines if files should be appended to an existing .zip archive if the Output File already exists on disk. If appending is disabled, existing .zip archives are overwritten.

Compression Level

When Compression Method is set to TAR GZ, this parameter determines how compressed the archive should be. A larger value will take longer to compress, but results in a smaller file size. The value can range between 1 and 9.

Schedulers

TOP Scheduler Override

This parameter overrides the TOP scheduler for this node.

Work Item Label

Determines how the node should label its work items. This parameter allows you to assign non-unique label strings to your work items which are then used to identify the work items in the attribute panel, task bar, and scheduler job names.

No Label

The work items on this node do not have a label.

Inherit From Upstream Item

The work items inherit their labels from their parent work items.

Custom Expression

The work item label is set to the Label Expression custom expression which is evaluated for each item.

Node Defines Label

The work item label is defined in the node’s internal logic.

Label Expression

When on, this parameter specifies a custom label for work items created by this node. The parameter can be an expression that includes references to work item attributes or built-in properties. For example, $OS: @pdg_frame will set the label of each work item based on its frame value.

Work Item Priority

This parameter determines how the current scheduler prioritizes the work items in this node.

Inherit From Upstream Item

The work items inherit their priority from their parent items. If a work item has no parent, its priority is set to 0.

Custom Expression

The work item priority is set to the value of Priority Expression.

Node Defines Priority

The work item priority is set based on the node’s own internal priority calculations.

This option is only available on the Python Processor TOP, ROP Fetch TOP, and ROP Output TOP nodes. These nodes define their own prioritization schemes that are implemented in their node logic.

Priority Expression

This parameter specifies an expression for work item priority. The expression is evaluated for each work item in the node.

This parameter is only available when Work Item Priority is set to Custom Expression.

Examples

example_top_filecompress Example for File Compress TOP node

This example demonstrates how to compress files using TOPs / PDG.

input1 Example for File Compress TOP node

input2 Example for File Compress TOP node

See also

TOP nodes