| On this page | |
| Since | 17.5 |
This node partitions work items based on their index value, or using a custom indexing scheme.
Tip
The $HH/help/files/pdg_examples/top_partitioners example shows how you can use common partitioner features like targeted partitioning, controls for merging attributes, and splitting by attribute.
Primary Input Rule
Determines how the work items from the node on the first/primary input are partitioned.
All
Each upstream item from the primary input is put into all partitions.
By Index
Each upstream item from the primary input is put into a partition based on its index.
None
Upstream items from the primary input aren’t put into any of the partitions.
Secondary Input Rule
Determines how the work items from the unordered secondary input are partitioned.
All
Each upstream item from the secondary input is put into all partitions.
By Index
Each upstream item from the secondary input is put into a partition based on its index.
Primary Intersection
Each upstream item from the secondary input is put into a partition based on its index, provided that there is an item from the primary input with the same index.
None
Upstream items from the secondary input aren’t put into any of the partitions.
These parameters control how attributes from input work items are merged onto the partitions produced by the node.
Merge Output Files
Determines how output files from work items in partitions are merged onto the partitions themselves. By default, all output files from the work item are copied into the partition output file list.
None
Output files are not merged onto partitions
First File
The output file(s) from the first work item in the partition are copied onto the partition.
Last File
The output file(s) from the last work item in the partition are copied onto the partition.
Unique Files
The unique file paths from all of the work items are copied onto the partition. The order of the files may change as this operation requires sorting the file list.
All Files
The output file(s) from all work items in the partition are copied onto the partition. The order of the files dependends on the order of the work items in the partition.
Merge Operations
Defines the number of attribute merge operations to perform on the partitioner node. The operations are used to merge attributes from work items in the partition onto the partition itself. Operations are performed in descending order. Attributes are merged using the first operation with a pattern that matches the attribute.
Apply Operation
Specifies the operation to perform to merge incoming attributes onto the partition. Each operation only applies only to the subset of attributes matched using the corresponding To Attributes parameter.
The following operations are available:
Ignore
Matching attributes are ignored and will not appear on the partition.
First Value
The value of each matching attribute on the first work item in the partition is kept, and values on subsequent work items are ignored
Last Value
The value of each matching attribute on the last work item in the partition is kept.
Unique Values
The unique values for each matching attribute are merged into an array. Duplicate values are discarded.
Append to Array
The values for each matching attribute are appended to an array for that attribute. All attribute values from all work items are kept.
Minimum
The minimum value for each matching attribute is kept.
Maximum
The maximum value for each matching attribute is kept.
Sum
The sum of the values in each matching attribute is stored on the partition.
Average
The average value of each matching attribute is stored on the partition.
Mode
The most common value in each matching attribute is kept.
Median
The middle value in each matching attribute is kept.
Sorted
The values for each matching attribute are merged into a sorted array.
SortedUnique
Attribute values across all work items are merged into a sorted array, and unique values are kept.
To Attributes
Specifies which attributes the corresponding Apply Operation parameter should apply to. This field can use the Attribute Pattern Syntax to specify multiple attributes.
Preserve Arrays
When on, the merge operation preserves the original array size of the incoming attributes. The merged array size is determined by the first value found across the input work items. When off, the partitioner flattens the incoming array attributes into a single sequence of values (a single scalar value) and performs the merge operation across all values.
These are advanced parameters that provide finer control over the behavior of the partitioner.
Partition When
Determines when the partitioning step is performed on the input work items.
Input Items are Generated
Upstream work items are partitioned once all of them have been generated
Input Items are Cooked
Upstream work items are partitioned once all of them are cooked. This may be required when the partitioning scheme is based on the results of the work items' execution.
This makes this partitioner behave like a 
Wait for All node except that it may create multiple partitions.A
Partition Target(s)
Determines which node or nodes(s) should target. Work items in the target nodes are partitioned as soon as they're generated even if the target nodes are not a direct input to this node. The descendants of the target work items are added to the partitions when they become available.
Direct Input Nodes
The partitioner uses work items from its direct input nodes. This is the default behavior
Upstream Static Nodes
The partitioner will skip over dynamic input nodes and partition work items from the nearest upstream static nodes.
Custom Target Node
The partitioner will use the node specified using the Custom Target Node parameter.
Custom Target Node
Specifies the target TOP node for the partition when Partition Targets is set to Custom Target Node. The partition scheme is applied to the work items in the target TOP node instead of this node’s input work items. The target TOP node must be in the same graph and above this node.
Ignore Failed Work Items
When this toggle is enabled, the partitioner node will skip input work items that are failed and create partitions from the subset of upstream work items that succeeded. This option is only meaningful if Partition When is set to Input Items are Cooked, or when the partitioner node is wired into a dynamic node that has upstream failures.
Split by Attribute
When on, the node splits input work items by the specified attribute(s) before partitioning them. The partitioning logic is evaluated on the list of work items for each distinct attribute value. Work items with different attribute values are always put into different partitions. Multiple attribute names can be specified as a space-separated list.
Missing Attribute
Determines how the node handles work items that are missing the split attribute.
This parameter is only available when Split by Attribute is on.
Ignore Work Item
Work items that are missing the split attribute are not put into any of the partitions.
Add Work Item to All Partitions
Work items that are missing the split attribute are put into all of the partitions.
Use Default Value
Work items that are missing the split attribute will use the value set by the Default Value parameter.
Default Value
Specifies the value to use for the split attribute for work items that are missing the attribute.
This parameter is only available when Missing Attribute is set to Use Default Value.
Allow Partial Matches
When Split by Attribute is set to a list of attribute names, this parameter determines how work items with only some of the attributes should be processed. If partial matches are enabled then work items will be added to split groups based on the attributes that do exist. Otherwise, work items with only a subset of the attributes will be excluded from the partitioning step.
Set Partition Frame To
Determines how the partitioner should set the frame value on partitions created by this node. If the partitioner already sets a custom frame value, for example like with a 
Python Partitioner SOP or 
Partition by Frame SOP, then this parameter has no effect.
None
No frame value is set on partitions.
First Work Item’s Frame
The frame value from the first work item based on the current Sort Contents By sort order is copied onto the partition.
Last Work Item’s Frame
The frame value from the last work item based on the current Sort Contents By sort order is copied onto the partition.
Largest Frame
The largest frame value from all work items in the partition is used for the partition’s frame.
Smallest Frame
The smallest frame value from all work items in the partition is used for the partition’s frame.
Sort Contents By
Determines the order that work items are sorted in when accessing the partitions on this node. This also affects the sort order of output files on the partition.
None
No sorting is applied. The work items in the partition are handled in no particular order.
Work Item Index
Work items in the partition are sorted based on their index.
Input Node Order
Work items in the partition are sorted based on the order of input nodes wired into this node. If two work items are from the same input, they are then sorted by index.
Attribute
Work items in the partition are sorted based on the attribute specified in the Sort Attribute field parameter.
Sort Direction
Determines whether the work items in this node’s partitions are sorted in ascending or descending order.
Sort Attribute
Specifies the name of the attribute to sort by.
This parameter is only available when Sort Contents By is set to Attribute.
Store Items to Attrib
When on, the list of IDs corresponding to the work items in the partition are written to the specified attribute. The work item IDs are stored as an integer array. This makes it easier to recover the list of partitioned work items downstream of the partitioner node.
PartitionByIndex Example for Partition by Index TOP node
This example demonstrates how to use the partition by index node in PDG/TOPs.
| See also |
Creates and modifies array attributes on work items.
Copies attributes from work items in one branch onto work items in another branch.
Creates or sets an attribute on all incoming work items.
Removes attributes from work items.
Modifies dictionary attributes by adding key/value pairs, removing keys, or merging existing dictionaries
Copies attributes and fields between work items, global attributes, and output files
Create randomly-generated integer and float attributes on work items.
Reduces array attribute values to a single value.
Renames attributes on work items.
Parses attribute values from a file into work items.
Parses attribute values from a string, such as a file name.
Starts a feedback loop. TOP nodes within the block execute serially, optionally looping for each incoming work item.
Ends a feedback loop. TOP nodes within the block execute serially, optionally looping for each incoming work item.
Copies data from a CSV file into work item attributes.
Writes work item attributes to a CSV file.
The PDG scheduler for Thinkbox’s Deadline software.
Downloads the contents from one or more URLs into files.
Edits the variables set in the environment work item command lines execute in.
Issues warnings or errors when a condition is met.
Encodes a sequence of still images as a video file.
Extracts a sequence of still images from a video file.
Compress files into an archive.
Copies a file from one location to another, either at runtime or whenever the node generates.
Decompresses archive files specified by incoming work items into individual files.
Creates work items based on files that match a certain pattern.
Creates a range of work items based on files that match a certain pattern.
Deletes a file at a specified path.
Renames or moves a file.
Filters upstream work items by their attribute names or values
Conditionally filters upstream work items.
Filter upstream work items that fall within a specified frame or attribute range.
Filters upstream work items by their state
Generates work items with no attributes that run a command line.
Loads points or primitives from a SOP or geometry file into work item attributes or a temporary file.
Creates work items that cook a digital asset
Schedules work items using HQueue.
Starts a Houdini service block
Provides easy access to ImageMagick functionality such as mass image convert, resize, and image mosaics.
Controls the scheduling of in-process work items.
Invokes a compiled block on input geometry
Extracts data from JSON files and creates attributes
Performs various operations that produce JSON output
Utility TOP to Collect and Archive current HIP file dependencies
Merges one or more text files into a single file.
Labs Cut Geometry to Partitions
Cuts up incoming geometry
Diffs a variety of geometry, text and image files.
Extracts image metadata, such as the resolution, bit depth, color model, etc.
Partition work items used for file caching
Partitions and generates work items based on range and wedge values for file cache.
Filters one or multiple work items by specific attribute values.
Labs Generate from Imageplanes
Generates work items based on image planes found in an image
The base template for synthetic dataset pipelines.
Schedules work items on the local machine.
Trains a neural network for regression.
Starts a Maya service block
Merge all upstream work items
Creates work items based on matched nodes.
Starts a Nuke service block
Does nothing
Notify an OP node that some TOP work has completed
Provides easy access to the OpenImageIO’s command line tool, also known as oiiotool, to perform operations on images such as color space conversion, color mapping, resizing, text overlay, and box overlay.
Subnet output
Partitions work items based on their attributes
Partitions source items spatially using the bounding items.
Partitions work items into pairs, triples, etc
Partitions work items using existing comparisons
Partitions work items based on an expression
Partitions work items based on their frame
Partitions work items based on their index
Partitions work items based on their feedback loop iteration.
Partitions work items based on their node
Partition work items based on range values
Partitions work items spatially using axis-aligned bounding boxes.
Execute Perforce commands through PDG
Starts a Python service block
Partitions work items using a Python script
Generates work items using a Python script.
A Python-based programmable Scheduler for PDG.
Creates work items that run a Python script.
Creates a Python virtual environment using TOPs
Creates work items that cook an embedded Alembic ROP node
Creates work items that cook an embedded Composite ROP node
Creates work items that cook an embedded FBX ROP node
Creates work items that cook a ROP node or network.
Creates work items that cook an embedded Geometry ROP node
Creates work items that cook an embedded Image ROP node
Creates work items that cook an embedded Karma ROP node.
Creates work items that cook an embedded Mantra ROP node
Creates work items that cook an embedded OpenGL ROP node
Creates work items that cook an embedded USD ROP node
Extend the frame range of upstream work items and adds new work items as necessary
Generates work items for the specified range.
Connected to a remotely executing TOP graph and displays the nodes from that graph
Creates work items that render an IFD file with Mantra
Sends an email.
Ends a service block.
Sends code to a service block to execute.
Creates a PDG service.
Deletes a PDG service.
Resets a PDG service.
Starts a PDG service.
Stops a PDG service.
Creates ShotGrid entities
Deletes entities from ShotGrid
Downloads ShotGrid attachments
Finds ShotGrid entities
Starts a persistent ShotGrid command server
Updates shotgun entities
Uploads files to shotgun
Sorts work items by a list of attributes
Splits upstream items in two
Splits upstream items into two using a fixed count
Container for TOP nodes
Switch which between network branches
Cooks another TOP network.
Input to a TOP fetch-ed network
Writes text to a new file or appends to an existing file.
Schedules work items using Pixar’s Tractor.
Trains an OIDN model using preprocessed training and validation datasets.
Creates work items that request data from a URL.
Adds USD assets to the Asset Gallery.
Fetches metadata, dependencies, and external references for a LOP Node or file.
Creates work items from prims found in a USD stage.
Creates work items from file references found in a USD stage.
Modify asset path attribute values.
Creates work items that render a USD file.
Creates work items that render a USD file or LOP network
Waits for all upstream work items to complete.
Creates work items with varying attribute values.
Expands file lists or partitions into multiple work items
Import work items from a .json file or another TOP node.
Extracts data from XML into Work Item attributes