Houdini 18.5 Reference Stand-alone utilities

husk

Command line utility for rendering a USD file using Karma or some other Hydra client.

On this page

husk [options] usd_file [-o image_file]

Tips

  • On Linux and macOS, you can send the husk process a SIGUSR1 signal on the command line (kill -USR1 pid) to force it to write out a snapshot image of the current render.

Options

Information

--help

Show this help.

--version

Print the renderer’s version string.

Karma

--properties

Print the names of all the rendering properties Karma understands, and their defaults.

--property-definition

Print full information about all the rendering properties Karma understands.

--property-definition-file filename

Save the full information about all the rendering properties Karma understands to a file. If the filename is -, writes the information to standard output.

--procedurals

Print all procedural definitions.

--filters

Print information about the filters and oracles Karma understands.

-p/--pixel-samples samples

Samples per pixel. Default is 128. Specifying this on the command line overrides any render settings in the USD file.

--bucket-size pixels

Size of render buckets, in pixels. Default is 128. Specifying this on the command line overrides any render settings in the USD file.

--tile-count xcount ycount

Husk can render a large image in multiple tiles. This option specifies the number of tiles in the x and y directions. It should be used in conjunction with the --tile-index option.

--tile-index index

When rendering a single image in tiles, this option specifies the index of the tile to be rendered. The index starts at 0. The number of tiles is determined by the --tile-count option.

--tile-suffix suffix

When rendering a single image in tiles, this option specifies a suffix added to the image filename, expanded using the --tile-index. This option uses the same rules as the -o option (for example _tile%02d). In expansion of the tile index, the F variable represents the tile index, while the N variable is the one-based tile index (starting at 1 instead of 0).

--disable-lighting

Do not render any lighting.

--ao-samples samples

Ambient occlusion samples (headlight shading). Default is 0.

--ao-distance n

Ambient occlusion distance cutoff. Default is 1.

--lock-random seed

Use seed as the random number seed instead of the frame number.

--dicingcamera prim_path

Dice using the camera at the given prim path. If this is not specified, Karma uses the render camera for dicing.

--optimize-offline level

This option is currently disabled and has no effect.

USD

--usd-input filepath

The USD scene file to render.

--list-settings

Prints information about the render settings primitives in the scene.

--list-cameras

Prints information about the cameras in the scene.

--purpose tokens

Which purpose(s) to render. This can be a comma separated list of purpose tokens. The default is geometry,render.

--complexity token

The geometry complexity to render at. Options are low, medium, high, and veryhigh.

--disable-motionblur

Overrides the instantaneousShutter render setting, forcing the shutter close time to be equal to the shutter open time. This effectively disables motion blur.

-s/--settings prim_path

Render using the RenderSettings at the given primitive path.

--prerender-script python_file

Run the given Python script prior to rendering. You can use the stage variable in the script to reference the USD stage being rendered. This script runs after the USD file is loaded, but before reading the settings primitive or rendering. The python_file argument is parsed into multiple arguments. Care should be taken to properly quote arguments that contain spaces. The hou.frame() function will return the first frame to be rendered.

--preframe-script python_file

Run the given Python script prior to each frame being rendered. You can use the stage variable in the script to reference the USD stage being rendered. This script runs after the USD file is loaded, but before reading the settings primitive or rendering. The python_file argument is parsed into multiple arguments. Care should be taken to properly quote arguments that contain spaces. The hou.frame() function will return the frame being rendered.

--postframe-script python_file

Run the given Python script after each frame is rendered. The stage variable is available and hou.frame() returns the frame that was just rendered.

--postrender-script python_file

Run the given Python script after all frames are rendered. The stage variable is available and hou.frame() returns the last frame rendered.

--usd-trace method

Enable USD function tracing. The method determines the reporting method: report – Print the time and sample counts for each function.

timing – Print the time spent in each function.

chrome – Generate JSON output suitable for vieing in the Chrome tracing format. This option requires the --usd-chrome-file option to specify the log file output.

Note that enabling this option may have a significant imapact on performance.

--usd-chrome-file filename

This option both enables USD function tracing (it implies --usd-trace chrome) and also specifies the filename where the JSON tracing information will be saved.

RenderSettings overrides

Specifying these on the command line overrides any render settings in the USD file.

-c/--camera prim_path

The primitive path of the camera to render from.

-o/--output file_path

Output image file path. This can contain certain local variables:

$F

Current frame number.

$FN

Current frame number with fixed number of digits, specified by a digit after the F. For example, $F4 expands to the current frame number as four digits (for example, 0001).

$FF

Floating point frame. This may be different from $F for expressions that are evaluated between frames (motion blur, simulations).

$N

The "ordinal" number of the frame currently being rendered (for example, for the first frame rendered, $N will always be 1, for the second frame rendered, $N will always be 2, and so on, even if, given the frame range, the first frame is frame 40).

<F>, <FF>, <F4>

Same as $F, $FF, $F4.

%d, %g, %04d

Same as $F, $FF, $F4.

-r/--res width height

Rendered image width and height, in pixels (e.g. --res 1280 720)

--pixel-aspect float

Pixel aspect ratio (pixel width as fraction of pixel height). Default is 1 (square pixels).

--make-output-path

Create any parent directories of the output image if they doesn’t already exist.

-f/--frame n

Start frame number. Default is 1.

-n/--frame-count n

Number of frames to render, including the start frame. Default is 1.

-i/--frame-inc n

Frame increment. Default is 1.

Rendering

-R/--renderer token

Render using an alternate Hydra client.

j/--threads n

Number of threads. 0 means use all processors. -1 uses all processors except one.

--fast-exit 0|1

Setting this to 0 does a full tear-down of the USD scene and Hydra interface.

--snapshot sec

Save a snapshot of the current state of the rendered image every sec seconds. -1 means no snapshots. Default is -1.

--exrmode mode

-1

Use HOUDINI_OIIO_EXR variable.

0

Use classic driver.

1

Use improved driver.

--mplay-monitor aovs

Automatically start up an mplay monitor of this render. The monitor can be used to observe progress as the image is rendered. The aovs specifies a comma separated list of AOVs to be displayed in mplay. For example --mplay-monitor C will only display the color plane (even if the image being written to disk has multiple AOVs). The option --mplay-monitor C,N,diffuse will send the C, N and diffuse planes to mplay for inspection. The selected AOVs must be present in the image being saved to disk to be displayed in the monitor.

If a single hyphen is given for the aovs (e.g. --mplay-monitor -), then all AOVs will be send to the monitor.

Warning: Closing the monitor will terminate the render.

--no-mplay

Disable any rendering to mplay. This option is useful when rendering on headless machines (on a farm).

--mplay-scale scale

Specify an scale for any renders to mplay. This includes the monitor or any mplay render products. The value for the scale argument is currently limited to 10 to 100 percent of the image being rendered to disk. The mplay image will be point-filtered, meaning there will be no blurring of the source pixels.

--mplay-update seconds

The number of seconds between updates of the mplay image.

--mplay-session label

Send mplay renderings to the session specified by the label.

--mplay-bgimage image

Specify an image to display in the background of mplay.

--mplay-gamma gamma

If the gamma value is greater than 0, set the display gamma in mplay.

--mplay-lut lut

Specify a display LUT for mplay.

--timelimit sec

Cancel the render if it takes more than sec seconds. The default -1 is no time limit.

--timelimit-image

--timelimit-nosave-partial

If the render hits the time limit, don’t save a partial image.

--stdout filename

Send standard output to the given file.

On Windows, you can use consolewait or consolenowait instead of a file name. consolewait opens a console window for the output, and you must close the window before the next frame will render. It lets you read fast-moving output but requires you to babysit the window. consolenowait opens a console window and closes it as soon as the frame is done. For slow renders you might still be able to read the output, and it doesn’t require you to click to close the window at every frame.

--stderr filename:

Send standard error to the given file. This file may be the same as the file specified by --stdout.

--append-stdout filename

Send standard output to the given file, appending to the file rather than replacing.

--append-stderr filename

Send stander error to the given file, appending to the file rather than replacing.

--windows-console mode

On windows, this option will override the redirection options and open a console to display output. The mode should either be wait or nowait.

-V/--verbose level

Print more or less information while rendering. Default is 2.

0-9

Verbosity of rendering statistics. Note that verbose levels of 8 and greater may affect rendering performance and should only be used for debugging problem scenes.

p

Enable VEX profiling (impacts performance)

P

Enable VEX profiling and NAN checks (severe impact on performance)

a/A

Turn on/off Alfred style progress

e/E

Turn on/off message elapsed time

t/T

Turn on/off message time stamps

Stand-alone utilities

  • abcconvert

    Convert between Alembic formats.

  • abcecho

    Print information about an Alembic file.

  • abcinfo

    Print information about an Alembic file.

  • chchan

    Copies channel collection to/from action channel format.

  • chcp

    Copies channel collection file to another format.

  • chinfo

    Prints information about a channel collection file.

  • claudio

    Copies CHOP data (clip) to/from audio formats.

  • clchan

    Copies CHOP data (clip) to/from action channel format.

  • clchn

    Copies CHOP data (clip) to/from channel collection format.

  • clcp

    Copies CHOP data (clip) to another format.

  • clinfo

    Prints information about a CHOP data (clip) file.

  • dsmconvert

  • dsmmerge

  • dsparse

    Parses and displays dialog scripts.

  • gabc

    Convert between Alembic and Houdini geometry.

  • gconvert

    Convert between Houdini polygon formats.

  • gdxf

    Converts DXF polygons to/from Houdini format.

  • geodiff

    Display Geometry Differences.

  • geps

    Converts EPS files to Houdini polygon format.

  • giges

  • ginfo

    Prints polygon file statistics.

  • glightwave

    Converts LightWave files to/from Houdini format.

  • gpdb

    Converts .pdb files to/from Houdini format.

  • gplay

    Geometry viewer.

  • gply

    Converts .ply files to/from Houdini format.

  • gptex

    Makes a ptexture image file from a geometry file.

  • greduce

    Reduces polygons in a file.

  • gwavefront

    Converts .obj files to/from Houdini format.

  • hbrickmap

    Converts an i3d file or volume primitive geo/bgeo file into a Pixar brickmap file.

  • hcollapse

    Collapses a directory structure.

  • hcpio

  • hexpand

    Expands hip files into a directory structure.

  • hkey / License Administrator

    Opens a graphical user interface for viewing and managing licenses and license server options.

  • hrender

  • hsc

  • hscript

    Command line HScript interpreter.

  • hserver

    Houdini communicates through this proxy server to the sesinetd licensing daemon.

  • husk

    Command line utility for rendering a USD file using Karma or some other Hydra client.

  • i3dconvert

  • iautocrop

    Crops images based on pixel values.

  • icineon

    Convert images from 10-bit Cineon format to an 8 bit format.

  • icomposite

  • iconvert

    Converts image formats.

  • icp

    Isolate a region of an image in a new image.

  • idenoise

    Removes noise from an image file.

  • idiff

    Display Image Differences.

  • iflip - Flip Image

  • iinfo

    Outputs information about an image.

  • ilut

    Generates a lookup table (LUT) from standard channel formats or another LUT.

  • ilutcomp

    Generates a single lookup table (LUT) from from two LUTs.

  • ilutinfo

    Prints information about a lookup table (LUT) file.

  • imaketx

    Creates mipmapped .exr or .rat textures from image files.

  • imdisplay

    Sends an image to an mdisplay window.

  • iprint

    Prints the RGBA values for an image as text.

  • iquantize

    Reduces the number of colors in an image.

  • isixpack

    Generates an environment/reflection map from six images representing the six sides of a cube, or a cross image.

  • itilestitch

    Assemble a series of image files with crop windows into a single image.

  • izg

    Converts Z-depth images to 8-bit grayscale images.

  • Launcher

    The Houdini Launcher downloads, installs, upgrades, and uninstall Houdini and its components.

  • mcacclaim

    Converts an Acclaim motion file to a Houdini script and channel file(s).

  • mcbiovision

    Converts a BioVision motion file to a Houdini script and channel file(s).

  • mcmotanal

    Converts a Motion Analysis TRC motion file to a Houdini script and channel file(s).

  • mcp

    Convert an image sequence to a movie file.

  • minfo

    Prints information about movie files.

  • mqserver

    Message Queue Server for PDG/TOPs

  • sesictrl

    Sets Houdini license server options from the command line.

  • sesinetd

    The Houdini license server. This program runs in the background managing Houdini licenses.

  • siminfo

    Prints simulation cache file statistics.

  • spiff

    Display Text Differences.

  • spy

    Shell utility for navigating the UNIX filesystem.

  • vexcache

    Query or modify the VEX compile cache.

  • vexexec

    Execute a cvex shader.