Houdini 20.5 Nodes TOP nodes

Filter by Range TOP node

Filter upstream work items that fall within a specified frame or attribute range.

On this page
Since 18.0

This node is a specialized version of the Filter by Expression node. You can use it to filter out work items that are inside or outside of a specified range. You can also choose whether the work items should be matched using their frame value, index, or a custom numeric attribute value.

TOP Attributes

range

 float

If the Set Range Attribute parameter is on, then the node writes the range values to a float attribute on each work item and adds a range attribute to each work item. This attribute is useful when you're using this node to select a subset of frames from a ROP Fetch node. Other downstream ROP Fetch nodes that are operating in batch mode will also use the range attribute when generating batches.

Parameters

Generate When

Determines when this node will generate work items. You should generally leave this set to “Automatic” unless you know the node requires a specific generation mode, or that the work items need to be generated dynamically.

All Upstream Items are Generated

This node will generate work items once all of the input nodes have generated their work items.

All Upstream Items are Cooked

This node will generate work items once all of the input nodes have cooked their work items.

Each Upstream Item is Cooked

This node will generate work items each time a work item in an input node is cooked.

Automatic

The generation mode is selected based on the generation mode of the input nodes. If any of the input nodes are generating work items when their inputs cook, this node will be set to Each Upstream Item is Cooked. Otherwise, it will be set to All Upstream Items are Generated.

Filtering

Operation

Remove Items in Filter Range

The node discards work items that fall within the Filter Range.

Keep Items in Filter Range

The node keeps work items that fall within the Filter Range.

Filter By

Determines which work item attribute to compare against the Filter Range.

Frame

The node uses a work item’s frame value to determine if it is included in the range.

Index

The node uses a work item’s index value to determine if it is included in the range.

Custom Attribute

The node uses a custom attribute, as specified by the Custom Attribute parameter, to determine if a work item is included in the range.

Custom Attribute

Specifies the name of the custom attribute the node uses to determine if a work item is included in the range. Since the Filter Range is numeric, the value of the custom attribute you specify must also be numeric (either a float or integer) for filtering to work correctly.

This parameter is only available when Filter By is set to Custom Attribute.

Specify Range As

Determines how the range of values for filtering is defined.

Value Range

The range is defined using a start, end and step value.

Custom Range

The range is defined using a Value Pattern. The pattern can contain multiple disjoint ranges, but can only consist of numeric values and ranges.

Value Range

When Specify Range As is set to Value Range, this parameter defines the start and end values for the range. The Inclusive toggle determines whether or not this is an exclusive range.

Custom Range

When Specify Range As is set to Custom Range, this parameter can be set to a Value Pattern that defines the range of values. The Inclusive toggle determines whether or not this is an exclusive range.

Inclusive

Determines whether or not the filter range is includes the last value in the range.

Attributes

Set Range Attribute

When on, the node writes the range values to a float attribute on each work item and adds a range attribute to each work item. This attribute is useful when you're using this node to select a subset of frames from a ROP Fetch node.

Other downstream ROP Fetch nodes that are operating in batch mode will also use the range attribute when generating batches. So if you plan to use the filtered work items with a ROP Fetch, you should enable this parameter.

This parameter is only available when Operation is set to Keep Items in Filter Range.

Include Output Files

When on, the node preserves the output file lists on the filtered work items.

Examples

FilterByRange Example for Filter by Range TOP node

This example demonstrates how the Filter by Range node can be used to filter work items by frame or attribute ranges.

See also

TOP nodes