Download Katana 1.1v4 Reference Guide PDF

TitleKatana 1.1v4 Reference Guide
LanguageEnglish
File Size1.3 MB
Total Pages192
Table of Contents
                            Cover
Contents
1 Preface
	About this Manual
	Getting Help
		Viewing Additional Help
		Contacting Customer Support
2 Nodes A-C
	AimConstraint
	Alembic_In
	ArnoldGlobalSettings
	ArnoldObjectSettings
	ArnoldOutputChannelDefine
	AttributeCopy
	AttributeEditor
	AttributeFile_In
	AttributeModifierDefine
	AttributeModifierResolve
	AttributeScript
	AttributeSet
	BillboardConstraint
	BoundsAdjust
	CameraClippingPlaneEdit
	CameraCreate
	CameraImagePlaneCreate
	CameraScreenWindowConstraint
	ClippingConstraint
	CollectionCreate
	ConstraintListEdit
	ConstraintResolve
	CoordinateSystemDefine
3 Nodes D-H
	DependencyMerge
	DollyConstraint
	Dot
	FaceSetCreate
	Fork3D
	FOVConstraint
	Gaffer
	Group
	GroupMerge
	GroupStack
4 Nodes I-K
	ImageAddMix
	ImageAtop
	ImageAverage
	ImageBackgroundColor
	ImageBlack
	ImageBlur
	ImageBrightness
	ImageChannels
	ImageClamp
	ImageColor
	ImageContrast
	ImageCrop
	ImageDifference
	ImageDistort
	ImageDivide
	ImageExclusion
	ImageExposure
	ImageFade
	ImageFrom
	ImageGain
	ImageGamma
	ImageGeometric
	ImageHypot
	ImageIn
	ImageInvert
	ImageLevels
	ImageMatte
	ImageMatteMix
	ImageMax
	ImageMin
	ImageMinus
	ImageMix
	ImageMultiply
	ImageOrient
	ImageOut
	ImageOver
	ImagePlus
	ImagePosition
	ImagePremultiply
	ImageRead
	ImageReformat
	ImageSaturation
	ImageScreen
	ImageText
	ImageTransform2D
	ImageUnder
	ImageUnpremultiply
	ImageWhite
	ImageWrite
	Importomatic
	InfoCreate
	InteractiveRenderFilters
	Isolate
5 Nodes L-Q
	LightCreate
	LightLink
	LightListEdit
	LiveGroup
	LiveGroupStack
	LocationCreate
	LodGroupCreate
	LodSelect
	LodValuesAssign
	LookFileAssign
	LookFileBake
	LookFileGlobalsAssign
	LookFileLightAndConstraintActivator
	LookFileManager
	LookFileMaterialsIn
	LookFileMaterialsOut
	LookFileResolve
	Material
	MaterialAssign
	MaterialResolve
	MaterialStack
	Merge
	NonpersistentSwitch
	OCIOCDLTransform
	OCIOColorSpace
	OCIODisplay
	OCIOFileTransform
	OCIOLogConvert
	OCIOLookTransform
	OrientConstraint
	ParentChildConstraint
	PointConstraint
	PrimitiveCreate
	PrmanGlobalSettings
	PrmanObjectSettings
	PrmanOutputChannelDefine
	PrmanShadingNode
	Prune
6 Nodes R-Z
	ReflectionConstraint
	Rename
	Render
	RenderOutputDefine
	RenderScript
	RenderSettings
	ScaleConstraint
	ScenegraphGeneratorResolve
	ScenegraphGeneratorSetup
	ScenegraphXml_In
	ScreenCoordinateConstraint
	ShadowBranch
	TeapotCreate
	Teleport
	TimeOffset
	Transform3D
	VelocityApply
	ViewerObjectSettings
	VisibilityAssign
                        
Document Text Contents
Page 1

REFERENCE GUIDE

VERSION 1.1v4

Page 2

Katana™ Reference Guide. Copyright © 2012 The Foundry Visionmongers Ltd. All Rights Reserved. Use of this document and the Katana software
is subject to an End User License Agreement (the "EULA"), the terms of which are incorporated herein by reference. This document and the Katana

software may be used or copied only in accordance with the terms of the EULA. This document, the Katana software and all intellectual property

rights relating thereto are and shall remain the sole property of The Foundry Visionmongers Ltd. ("The Foundry") and/or The Foundry's licensors.

The EULA can be read in the Katana User Guide.

The Foundry assumes no responsibility or liability for any errors or inaccuracies that may appear in this document and this document is subject to

change without notice. The content of this document is furnished for informational use only.

Except as permitted by the EULA, no part of this document may be reproduced, stored in a retrieval system or transmitted, in any form or by any
means, electronic, mechanical, recording or otherwise, without the prior written permission of The Foundry. To the extent that the EULA

authorizes the making of copies of this Reference Guide, such copies shall be reproduced with all copyright, trademark and other proprietary rights

notices included herein. The EULA expressly prohibits any action that could adversely affect the property rights of The Foundry and/or The
Foundry's licensors, including, but not limited to, the removal of the following (or any other copyright, trademark or other proprietary rights notice

included herein):

Katana™software © 2012 The Foundry Visionmongers Ltd. All Rights Reserved.

Katana™ is a trademark of The Foundry Visionmongers Ltd.

Sony Pictures Imageworks is a trademark of Sony Pictures Imageworks.

In addition to those names set forth on this page, the names of other actual companies and products mentioned in this Reference Guide (including,
but not limited to, those set forth below) may be the trademarks or service marks, or registered trademarks or service marks, of their respective

owners in the United States and/or other countries. No association with any company or product is intended or inferred by the mention of its

name in this document.

Linux ® is a registered trademark of Linus Torvalds.

Katana software engineering: Andy Lomas, Jonathan Attfield, Chris Hallam, Joao Montenegro, Orn Gunnarsson, Andrew Bulhak, Andy Abgottspon,

Stefan Habel, Chris Beckford, Luke Titley, Steve LaVietes, Jeremy Selan, Brian Hall
Product testing: Phillip Mullan, Richard Ellis, Claire Connolly

Katana customer support engineer and supplementary testing: Iulia Giurca

Initial writing: Sony Pictures Imageworks
Main reference guide authors: Charles Quinn, Joel Byrne, Eija Narvanen, Tytti Pohjola, Gary Jones

Proof reading: Charles Quinn, Eija Narvanen, Gary Jones

The Foundry

6th Floor, Communications Building,

48 Leicester Square,
London

WC2H 7LT

Rev: September 18, 2012
The Foundry Katana 1.1v4

Page 96

NODES I-K 96
ImageMatte
• ImageIn - Bf. This only shows the areas of the background that over-
lap with the alpha of the foreground. It can be useful for combining
mattes.

• ImageMatte - Ff*B(1-f). This is a premultiplied ImageOver. Use unpre-
multiplied images with this operation.

• ImageMax - max(F,B). This takes the maximum values of both images.
This is a good way to combine mattes and useful for bringing aspects
like bright hair detail through.

• ImageMin - min(F,B). This takes the minimum values of both images.

• ImageMinus - B-F. This subtracts the foreground from the back-
ground. For subtracting the background from the foreground instead,
see ImageFrom.

• ImageMultiply - FB. This multiplies the values of the foreground by the
values of the background. It can be used to composite darker values
from the foreground with the background image - dark gray smoke
shot against a white background, for example.

• ImageOut - B(1-f). This only shows the areas of the background that
do not overlap with the alpha of the foreground. This can be useful for
combining mattes.

• ImageOver - F+B(1-f). This layers the foreground over the background
according to the alpha of the foregound. This is the most commonly
used operation. It's used when layering a foreground element over a
background plate.

• ImagePlus - F+B. This produces the sum of the foreground and back-
ground. Note that the add algorithm may result in pixel values higher
than 1.0.

• ImageScreen - F+B-FB. This is similar to ImageHypot, but clamps pixel
values to 1.0. This is mostly useful for combining mattes.

• ImageUnder - F(1-b)+B. This is the reverse of the ImageOver opera-
tion. It layers the background over the foreground according to the
alpha of the background.

amount 1 Dissolves between the bg image at 0 and the full merge effect at 1.

displayWindow Background The frame size to output in the event that the fg and bg inputs are dif-
ferent sizes:

• Background - output the frame size of the bg input.

• Foreground - output the frame size of the fg input.

• Union - output a combination of the bg and fg inputs' frame sizes.

• Intersection - output an intersection of the bg and fg inputs' frame
sizes. This restricts the output to the area where the two frame sizes
overlap.

clampAlpha enabled When enabled, the output alpha channel is clamped to the 0-1 range.
Color channels (RGB) are not affected.

Control (UI) Default Value Function
Katana 1.1v4The Foundry

Page 97

NODES I-K 97
ImageMatteMix
ImageMatteMix

This node uses a matte to control the mixing of two image, background and foreground.

Control (UI) Default Value Function

R enabled When enabled, affect the red channel of the image.

G enabled When enabled, affect the green channel of the image.

B enabled When enabled, affect the blue channel of the image.

A enabled When enabled, affect the alpha channel of the image.

mix 1 Dissolves between the background image at 0 and the foreground image
at 1.

Mask

channel A The channel from the out_mask input to use as a mask:

• R - use the red channel as the mask.

• G - use the green channel as the mask.

• B - use the blue channel as the mask.

• A - use the alpha channel as the mask.

By default, the mix effect is limited to the non-black areas of the mask.

invert disabled Inverts the use of the mask channel so that the mix effect is limited to
the non-white areas of the mask.

fringe disabled When enabled, the mask is modified so that by default the mix effect is
limited to the fringe (semi-transparent areas).

amount 1 An optional bias for the mix operation. See amountMath for details.

amountMath Normal Select the mode to use:

• Normal - In this mode, an amount of 1 means to obey the matte fully.
An amount of less than 1 means to mix in more of the original bg
image. This corresponds to artists' expectations.

• Compatibility - In this mode, an amount of 0 favors the bg image. An
amount towards 1 favors the fg image. 0.5 is the non-biased setting.

matteChannel A Specifies which channel in the matte input contains the matte.

displayWindow Background The frame size to output in the event that the fg and bg inputs are dif-
ferent sizes:

• Background - output the frame size of the bg input.

• Foreground - output the frame size of the fg input.

• Union - output a combination of the bg and fg inputs' frame sizes.

• Intersection - output an intersection of the bg and fg inputs' frame
sizes. This restricts the output to the area where the two frame sizes
overlap.
Katana 1.1v4The Foundry

Page 191

NODES R-Z 191
VisibilityAssign
VisibilityAssign

The VisibilityAssign node changes the visiblility setting of objects in the scene. The attribute is inherited,
thus large sections of the Scene Graph can be made visible / invisible by assigning to common parents

A child can be explicitly set to visible even if its parent is not visible. For example, to render just one of
several siblings, set the parent's visibility to 0, and set the item to render's visibility to 1. All siblings that
are not explicitly marked will pick up the parent's visibility setting of 0, but the item to render will use its
explicitly set value of 1.

The Scene Graph displays visibility of each Scene Graph item as icons.

light inherit Sets the lighting model for the object. This setting doesn’t influence the
object when it is drawn using wireframe or points. You can set it to:

• default - uses the simple shaded lighting model.

• shaded - uses the viewer shader assigned to the object (or the default
viewer shader if one isn’t assigned).

• inherit - don’t override the Viewer tab display style.

smoothing inherit When the objects referenced by the CEL statement are beign displayed
as points or lines, this parameter sets whether they should be anti-
aliased. The options are:

• off - no anti-aliasing.

• lines - when displayed as a wireframe, the objects are anti-aliased.

• points - when displayed using points, the objects are anti-aliased.

• both - when displayed as a wireframe or using points, the objects are
anti-aliased.

• inherit - no object specific override, use the current default.

windingOrder inherit Sets whether the object has a clockwise or counterclockwise winding
order. The winding order determines which direction is considerd out
from an object and which direction is in.

pointSize 4 Sets the size of the points when the object is rendered as a series of
points.

annotation

text None Sets the text to display with the geometry. When empty, no tag is dis-
played.

color 0.4, 0.4, 0.4 Sets the default background color for any annotation text.

pickable Yes Sets whether the object is pickable or not.

Control (UI) Default Value Function
Katana 1.1v4The Foundry

Page 192

NODES R-Z 192
VisibilityAssign
Control (UI) Default Value Function

CEL none Collection Expression Language. Used to specify Scene Graph locations
on which an operation or assignment will act. Specifies what part of the
Scene Graph to assign this attribute to.

For more information, see the CEL Reference document found on the
documentation HTML page (accessed through the Help > Documentation
menu option).

visible 1 Sets the visibility of objects in the render. 0 specifies not visible in ren-
der and anything else specifies visible in render.
Katana 1.1v4The Foundry

Similer Documents