us.temerity.pipeline.plugin.NukeRescaleAction.v2_4_2
Class NukeRescaleAction

java.lang.Object
  us.temerity.pipeline.Named
      us.temerity.pipeline.PluginID
          us.temerity.pipeline.BasePlugin
              us.temerity.pipeline.BaseAction
                  us.temerity.pipeline.plugin.CommonActionUtils
                      us.temerity.pipeline.plugin.CompositeActionUtils
                          us.temerity.pipeline.plugin.NukeActionUtils
                              us.temerity.pipeline.plugin.NukeRescaleAction.v2_4_2.NukeRescaleAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class NukeRescaleAction
extends NukeActionUtils

Provides control over generating and/or running a Nuke script containing a Reformat node which can rescale 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 rescales the images specified by Image Source to generate the target images.

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

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

Image Source

When using Process or Read & Rescale mode, this parameter specifies the source node containing the images to rescale. Ignored in Rescale mode.

Scale

The scaling factor to apply to the source images.

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.

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	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	aHeight
static String	aImageSource
static String	aImpulse
static String	aKeys
static String	aMitchell
static String	aMode
static String	aNone
static String	aNotch
static String	aParzen
static String	aPreserveBBox
static String	aProcess
static String	aReadAndRescale
static String	aRescale
static String	aResizeType
static String	aRifman
static String	aScale
static String	aSimon
static String	aTurn
static String	aWidth

Fields inherited from class us.temerity.pipeline.plugin.CompositeActionUtils

aAdd, aAlphaAdd, aAlphaMode, aBlack, aBlendMode, aClassicColorBurn, aClassicColorDodge, aClassicDifference, aColor, aColorBurn, aColorDodge, aCompFrameRate, aCompHeight, aCompPixelRatio, aCompWidth, aDancingDissolve, aDarken, aDifference, aDissolve, aExclusion, aFrameRate, aHardLight, aHue, aIgnore, aLayer, aLighten, aLinearBurn, aLinearDodge, aLinearLight, aLuminescentPremul, aLuminosity, aMultiply, aNormal, aOrder, aOverlay, aPass, aPinLight, aPixelRatio, aPreMultColor, aPreMultipled, aSaturation, aScreen, aSilhouetteAlpha, aSilhouetteLuma, aSoftLight, aStencilAlpha, aStencilLuma, aStraight, aVividLight, aWhite

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

NukeRescaleAction()

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.NukeActionUtils

getNukeExtensions, getNukeProgram, getNukeProgram, getNukeProgramVersion, getNukeProgramVersion, toNukeFilePattern, toNukeFrameRange

Methods inherited from class us.temerity.pipeline.plugin.CompositeActionUtils

addCompFrameRateParam, addCompHeightParam, addCompPixelRatioParam, addCompWidthParam, addSourceAlphaModeParam, addSourceFrameRateParam, addSourceLayerParam, addSourceOrderParam, addSourcePassParam, addSourcePixelRatioParam, addSourcePreMultColorParam

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

aReadAndRescale

public static final String aReadAndRescale

See Also:

Constant Field Values

aRescale

public static final String aRescale

See Also:

Constant Field Values

aImageSource

public static final String aImageSource

See Also:

Constant Field Values

aScale

public static final String aScale

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

NukeRescaleAction

public NukeRescaleAction()

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.