TEMERITY

us.temerity.pipeline.plugin.NukeReformatAction.v2_4_2
Class NukeReformatAction

java.lang.Object
  extended by us.temerity.pipeline.Named
      extended by us.temerity.pipeline.PluginID
          extended by us.temerity.pipeline.BasePlugin
              extended by us.temerity.pipeline.BaseAction
                  extended by us.temerity.pipeline.plugin.CommonActionUtils
                      extended by us.temerity.pipeline.plugin.PythonActionUtils
                          extended by us.temerity.pipeline.plugin.NukeReformatAction.v2_4_2.NukeReformatAction
All Implemented Interfaces:
Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeReformatAction
extends PythonActionUtils

Provides control over generating and/or running a Nuke script containing a Reformat node which can modify the resolution and orientation of a set of source images.

This action defines the following single valued parameters:

Mode
The mode of operation for this action:
Process - Dynamically creates and executes a Nuke script which reformats the images specified by Image Source to generate the target images.

Read & Reformat - Generates a target Nuke script which reads and reformats the images specified by Image Source.

Reformat - Generates a target Nuke script which contains a single Nuke Reformat node.


Image Source
When using Process or Read & Reformat mode, this parameter specifies the source node containing the images to reformat. Ignored in Reformat mode.

Output Resolution

The width and height in pixels of the output images when Nuke's proxy mode is OFF.

Output Aspect
The pixel aspect ration of the output images when Nuke's proxy mode is OFF.

Output Res Source
If specified, the Output Resolution is determined by the size of the images associated with the given source node.

Proxy Resolution

The width and height in pixels of the output images when Nuke's proxy mode is ON.

Proxy Aspect
The pixel aspect ration of the output images when Nuke's proxy mode is ON.

Proxy Res Source
If specified, the Proxy Resolution is determined by the size of the images associated with the given source node.

Resize Type

The direction which controls the scaling factor:
None - Don't change the pixels.

Width - Scale to the image fills the output width.

Height - Scale to the image fills the output height.

Fit - Scale to the smaller of width or height.

Fill - Scale to the larger of width or height.

Distort - Non-uniform scale to match both width and height.


Center
Whether to translate the image to center it in the output.

Flip
Whether to mirror the image vertically.

Flop
Whether to mirror the image horizontally.

Turn
Whether to rotate the image 90 degrees.

Filter

The method used to process pixels from the input image to produce pixels in the output image:
Impulse - No filtering, each output pixel is directly copied from an input pixel.

Cubic - Smooth interpolate between pixels.

Keys - Cubic (a=0.5), aproximates sync.

Simon - Cubic (a=0.75), continuous second derivative.

Rifman - Cubic (a=1.0), lots of sharpening.

Mitchell - Mix of sharpening and smoothing.

Parzen - Aproximating B-spline.

Notch - Hides moire patterns.


Clamp
Whether to set negative intermediate and final results to zero. This will remove ringing around mattes when using a filter that has negative lobes.

Crop
Whether to set pixels outside the input format to black.

Preserve BBox
Whether to preserve pixels outside the output format bounding box.

Extra Options

Additional command-line arguments for Nuke.

This action uses the Imagemagick identify(1) utility to analyze the source images.

By default, the "python" program may be used by this action to run identify(1), construct a dynamic Nuke script and optionally run Nuke itself on this script. An alternative program can be specified by setting PYTHON_BINARY in the Toolset environment to the name of the Python interpertor this Action should use. When naming an alternative Python interpretor under Windows, make sure to include the ".exe" extension in the program name.

By default, this Action executes the "Nuke4.6" binary. This can be overridden by specifying an alternate binary with the NUKE_BINARY environmental variable in the Toolset used to run this Action plugin. On Windows, the Nuke binary name should include the ".exe" extension.

See Also:
Serialized Form

Field Summary
static String aCenter
           
static String aCine1K
           
static String aCine2K
           
static String aCine4K
           
static String aClamp
           
static String aCrop
           
static String aCubic
           
static String aDistort
           
static String aFill
           
static String aFilter
           
static String aFit
           
static String aFlip
           
static String aFlop
           
static String aHD
           
static String aHeight
           
static String aImageSource
           
static String aImpulse
           
static String aKeys
           
static String aMitchell
           
static String aMode
           
static String aNone
           
static String aNotch
           
static String aNTSC
           
static String aNTSC169
           
static String aOutputAspect
           
static String aOutputFormats
           
static String aOutputResolution
           
static String aOutputResSource
           
static String aPAL
           
static String aPAL169
           
static String aParzen
           
static String aPCVideo
           
static String aPreserveBBox
           
static String aProcess
           
static String aProxyAspect
           
static String aProxyFormats
           
static String aProxyResolution
           
static String aProxyResSource
           
static String aReadAndReformat
           
static String aReformat
           
static String aResizeType
           
static String aRifman
           
static String aRootFormat
           
static String aSimon
           
static String aSquare1K
           
static String aSquare256
           
static String aSquare2K
           
static String aSquare512
           
static String aSuper1K
           
static String aSuper2K
           
static String aSuper4K
           
static String aTurn
           
static String aWidth
           
 
Fields inherited from class us.temerity.pipeline.plugin.CommonActionUtils
aExtraOptions
 
Fields inherited from class us.temerity.pipeline.BasePlugin
pDescription
 
Fields inherited from class us.temerity.pipeline.PluginID
pVendor, pVersionID
 
Fields inherited from class us.temerity.pipeline.Named
pName
 
Constructor Summary
NukeReformatAction()
           
 
Method Summary
 SubProcessHeavy prep(ActionAgenda agenda, File outFile, File errFile)
          Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.
 
Methods inherited from class us.temerity.pipeline.plugin.PythonActionUtils
createPythonSubProcess, createPythonSubProcess, createPythonSubProcess, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonFileVerify, getPythonIndent, getPythonLaunchHeader, getPythonLaunchPipeHeader, getPythonProgram, getPythonProgram
 
Methods inherited from class us.temerity.pipeline.plugin.CommonActionUtils
addExtraOptionsParam, addExtraOptionsParamToLayout, createScriptSubProcess, createSubProcess, createSubProcess, createSubProcess, createSubProcess, createTempCopySubProcess, createTempScript, escPath, escPath, getExtraOptionsArgs, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePath, getPrimarySourcePaths, getPrimarySourcePaths, getPrimarySourcePaths, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPath, getPrimaryTargetPaths, getPrimaryTargetPaths, getPrimaryTargetPaths, getSecondarySourceBooleanParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceDoubleParamValue, getSecondarySourceEnumParamIndex, getSecondarySourceIntegerParamValue, getSecondarySourceIntegerParamValue, getSecondarySourceLongParamValue, getSecondarySourceLongParamValue, getSecondarySourceOptionalBooleanParamValue, getSecondarySourceStringParamValue, getSecondarySourceStringParamValue, getSingleBooleanParamValue, getSingleDoubleParamValue, getSingleDoubleParamValue, getSingleEnumParamIndex, getSingleIntegerParamValue, getSingleIntegerParamValue, getSingleLongParamValue, getSingleLongParamValue, getSingleOptionalBooleanParamValue, getSingleStringParamValue, getSingleStringParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2dParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple2iParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3dParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple3iParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSingleTuple4dParamValue, getSourceBooleanParamValue, getSourceDoubleParamValue, getSourceDoubleParamValue, getSourceEnumParamIndex, getSourceIntegerParamValue, getSourceIntegerParamValue, getSourceLongParamValue, getSourceLongParamValue, getSourceOptionalBooleanParamValue, getSourceStringParamValue, getSourceStringParamValue, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePath, getWorkingNodeFilePaths
 
Methods inherited from class us.temerity.pipeline.BaseAction
addPreset, addPresetValues, addSingleParam, chmod, cleanupLater, clearAllLinkParams, clearLinkParams, clone, createTemp, createTemp, equals, equalSingleParams, equalSourceParams, fromGlue, getInitialSourceParams, getPluginType, getPresetChoices, getPresetValues, getSecondarySequences, getSecondarySourceNames, getSecondarySourceParam, getSecondarySourceParams, getSecondarySourceParamValue, getSingleLayout, getSingleParam, getSingleParams, getSingleParamValue, getSourceLayout, getSourceNames, getSourceParam, getSourceParams, getSourceParamValue, getTempDir, getTempPath, hasSecondarySourceParams, hasSingleParams, hasSourceParams, initSecondarySourceParams, initSourceParams, removeAllSourceParams, removeSecondarySourceParams, removeSecondarySourceParams, removeSourceParams, setSecondarySourceParamValue, setSingleLayout, setSingleParamValue, setSingleParamValues, setSourceLayout, setSourceParamValue, setSourceParamValues, supportsSourceParams, toGlue
 
Methods inherited from class us.temerity.pipeline.BasePlugin
addSupport, compareTo, getDescription, getFullMessage, getPluginID, getResource, getResources, getResourceSize, getSupports, isUnderDevelopment, removeSupport, setSupports, supports, toString, underDevelopment
 
Methods inherited from class us.temerity.pipeline.PluginID
getVendor, getVersionID
 
Methods inherited from class us.temerity.pipeline.Named
getName
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

aMode

public static final String aMode
See Also:
Constant Field Values

aProcess

public static final String aProcess
See Also:
Constant Field Values

aReadAndReformat

public static final String aReadAndReformat
See Also:
Constant Field Values

aReformat

public static final String aReformat
See Also:
Constant Field Values

aImageSource

public static final String aImageSource
See Also:
Constant Field Values

aRootFormat

public static final String aRootFormat
See Also:
Constant Field Values

aPCVideo

public static final String aPCVideo
See Also:
Constant Field Values

aNTSC

public static final String aNTSC
See Also:
Constant Field Values

aPAL

public static final String aPAL
See Also:
Constant Field Values

aHD

public static final String aHD
See Also:
Constant Field Values

aNTSC169

public static final String aNTSC169
See Also:
Constant Field Values

aPAL169

public static final String aPAL169
See Also:
Constant Field Values

aSuper1K

public static final String aSuper1K
See Also:
Constant Field Values

aCine1K

public static final String aCine1K
See Also:
Constant Field Values

aSuper2K

public static final String aSuper2K
See Also:
Constant Field Values

aCine2K

public static final String aCine2K
See Also:
Constant Field Values

aSuper4K

public static final String aSuper4K
See Also:
Constant Field Values

aCine4K

public static final String aCine4K
See Also:
Constant Field Values

aSquare256

public static final String aSquare256
See Also:
Constant Field Values

aSquare512

public static final String aSquare512
See Also:
Constant Field Values

aSquare1K

public static final String aSquare1K
See Also:
Constant Field Values

aSquare2K

public static final String aSquare2K
See Also:
Constant Field Values

aOutputFormats

public static final String aOutputFormats
See Also:
Constant Field Values

aOutputResolution

public static final String aOutputResolution
See Also:
Constant Field Values

aOutputAspect

public static final String aOutputAspect
See Also:
Constant Field Values

aOutputResSource

public static final String aOutputResSource
See Also:
Constant Field Values

aProxyFormats

public static final String aProxyFormats
See Also:
Constant Field Values

aProxyResolution

public static final String aProxyResolution
See Also:
Constant Field Values

aProxyAspect

public static final String aProxyAspect
See Also:
Constant Field Values

aProxyResSource

public static final String aProxyResSource
See Also:
Constant Field Values

aResizeType

public static final String aResizeType
See Also:
Constant Field Values

aNone

public static final String aNone
See Also:
Constant Field Values

aWidth

public static final String aWidth
See Also:
Constant Field Values

aHeight

public static final String aHeight
See Also:
Constant Field Values

aFit

public static final String aFit
See Also:
Constant Field Values

aFill

public static final String aFill
See Also:
Constant Field Values

aDistort

public static final String aDistort
See Also:
Constant Field Values

aFilter

public static final String aFilter
See Also:
Constant Field Values

aImpulse

public static final String aImpulse
See Also:
Constant Field Values

aCubic

public static final String aCubic
See Also:
Constant Field Values

aKeys

public static final String aKeys
See Also:
Constant Field Values

aSimon

public static final String aSimon
See Also:
Constant Field Values

aRifman

public static final String aRifman
See Also:
Constant Field Values

aMitchell

public static final String aMitchell
See Also:
Constant Field Values

aParzen

public static final String aParzen
See Also:
Constant Field Values

aNotch

public static final String aNotch
See Also:
Constant Field Values

aCenter

public static final String aCenter
See Also:
Constant Field Values

aFlip

public static final String aFlip
See Also:
Constant Field Values

aFlop

public static final String aFlop
See Also:
Constant Field Values

aTurn

public static final String aTurn
See Also:
Constant Field Values

aClamp

public static final String aClamp
See Also:
Constant Field Values

aCrop

public static final String aCrop
See Also:
Constant Field Values

aPreserveBBox

public static final String aPreserveBBox
See Also:
Constant Field Values
Constructor Detail

NukeReformatAction

public NukeReformatAction()
Method Detail

prep

public SubProcessHeavy prep(ActionAgenda agenda,
                            File outFile,
                            File errFile)
                     throws PipelineException
Construct a SubProcessHeavy instance which when executed will fulfill the given action agenda.

Overrides:
prep in class BaseAction
Parameters:
agenda - The agenda to be accomplished by the action.
outFile - The file to which all STDOUT output is redirected.
errFile - The file to which all STDERR output is redirected.
Returns:
The SubProcess which will fulfill the agenda.
Throws:
PipelineException - If unable to prepare a SubProcess due to illegal, missing or imcompatable information in the action agenda or a general failure of the prep method code.

TEMERITY