Skip to content

cops

cops

MCP tool wrappers for Houdini COP (Copernicus) operations.

Each tool delegates to the corresponding handler running inside Houdini via the HTTP bridge.

Functions:

Name Description
create_cop_node

Create a COP node in the specified network.
get_cop_geometry

Get geometry representation from a COP node.
get_cop_info

Get information about a COP node.
get_cop_layer

Get image layer data from a COP node.
get_cop_vdb

Get VDB volumetric data from a COP node.
list_cop_node_types

List available COP node types.
set_cop_flags

Set flags on a COP node.

Functions:

create_cop_node async 

create_cop_node(
    ctx: Context, parent_path: str, cop_type: str, name: str | None = None
) -> dict

Create a COP node in the specified network.

Before using this, call list_node_types(context='Cop', filter='') for Copernicus nodes (Houdini 20+), or context='Cop2' for legacy COPs. Copernicus is the modern image processing system and is preferred over COP2 (deprecated as of Houdini 20.5). COPs has many dedicated image-processing nodes — blur, sharpen, levels, contrast, over, multiply, luminance, premultiply, channelcopy, noise, ramp, fractalnoise, worleynoise, rasterizegeo, heighttonormal, sdfshape — that may cover the operation without needing a VEX COP or Python.

Parameters:

Name Type Description Default
parent_path
str

Path to the parent COP network.

 required
cop_type
str

COP node type to create.

 required
name
str | None

Override node name.

 None

get_cop_geometry async 

get_cop_geometry(ctx: Context, node_path: str, output_index: int = 0) -> dict

Get geometry representation from a COP node.

Parameters:

Name Type Description Default
node_path
str

Path to the COP node.

 required
output_index
int

Output connector index.

 0

get_cop_info async 

get_cop_info(ctx: Context, node_path: str) -> dict

Get information about a COP node.

Parameters:

Name Type Description Default
node_path
str

Path to the COP node.

 required

get_cop_layer async 

get_cop_layer(
    ctx: Context,
    node_path: str,
    output_index: int = 0,
    wire: int | str | None = None,
    wire_sum: bool = False,
) -> dict

Get image layer data from a COP node.

A cable output (more than one wire) answers is_cable and wires (name, data type and each wire's layer summary); copernicus_layer is the wire named by wire (index or name, default the first), see layer_read. wire_sum=True adds min/max/average of the per-pixel sum of the one-channel wires, e.g. to check that blend weights sum to 1.

Parameters:

Name Type Description Default
node_path
str

Path to the COP node.

 required
output_index
int

Output connector index.

 0
wire
int | str | None

On a cable output, the wire to read (index or name).

 None
wire_sum
bool

On a cable output, stats of the per-pixel sum of its wires.

 False

get_cop_vdb async 

get_cop_vdb(ctx: Context, node_path: str, output_index: int = 0) -> dict

Get VDB volumetric data from a COP node.

Parameters:

Name Type Description Default
node_path
str

Path to the COP node.

 required
output_index
int

Output connector index.

 0

list_cop_node_types async 

list_cop_node_types(ctx: Context, filter: str | None = None) -> dict

List available COP node types.

Parameters:

Name Type Description Default
filter
str | None

Substring filter for node type names.

 None

set_cop_flags async 

set_cop_flags(
    ctx: Context,
    node_path: str,
    display: bool | None = None,
    export_flag: bool | None = None,
    compress: bool | None = None,
) -> dict

Set flags on a COP node.

Parameters:

Name Type Description Default
node_path
str

Path to the COP node.

 required
display
bool | None

Display flag state.

 None
export_flag
bool | None

Render/export flag state.

 None
compress
bool | None

Compress flag state.

 None