us.temerity.pipeline.plugin.DsmToTifAction.v2_2_1
Class DsmToTifAction

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.PythonActionUtils
                          us.temerity.pipeline.plugin.DsmToTifAction.v2_2_1.DsmToTifAction

All Implemented Interfaces:

Serializable, Cloneable, Comparable<PluginID>, Glueable

public class DsmToTifAction
extends PythonActionUtils

Converts a depth slice from a 3Delight deep shadow map (DSM) into a TIF image suitable for display.

Converts the DSMs (.shd) which make up the primary file sequence of one of the source nodes into the TIFF images which make up the primary file sequence of this node.

See the 3Delight documentation for dsm2tif(1) for details.

This action defines the following single valued parameters:

DSM Source

The source node which contains the DSM files to convert.

Sample Method

The depth sampling method:

• Relative - Each pixel is evaluated at a relative depth between the minimum and maximum depth values for the sampled pixel.
• Absolute - Each pixel is evaluated a depth between the minimum and maximim depth values of the entire DSM.

Sample Depth

The sample depth [0,1]. The interpretation of this depth depends on the Sample Method.

Shadow Bias

The shadow bias used to avoid self occulsion when evaluating the DSM.

Mipmap Level

Specifies the mipmap level of the DSM to evaluate.

Output Value

The meaning of color values in the output TIF images:

• Visibility - White means unocculded, black means fully occluded.
• Opacity - White means fully occluded, black meand unoccluded.

Pixel Type

The pixel data type of the output TIF images.

Compression

The compression method to use for the output TIF images.

By default, the "python" program is used by this action to run the "dsm2tif" commands. 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.

See Also:

Serialized Form

Field Summary

static String	aCompression
static String	aDSMSource
static String	aMipmapLevel
static String	aOutputValue
static String	aPixelType
static String	aSampleDepth
static String	aSampleMethod
static String	aShadowBias

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

DsmToTifAction()

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

aDSMSource

public static final String aDSMSource

See Also:

Constant Field Values

aSampleMethod

public static final String aSampleMethod

See Also:

Constant Field Values

aSampleDepth

public static final String aSampleDepth

See Also:

Constant Field Values

aShadowBias

public static final String aShadowBias

See Also:

Constant Field Values

aMipmapLevel

public static final String aMipmapLevel

See Also:

Constant Field Values

aOutputValue

public static final String aOutputValue

See Also:

Constant Field Values

aPixelType

public static final String aPixelType

See Also:

Constant Field Values

aCompression

public static final String aCompression

See Also:

Constant Field Values

Constructor Detail

DsmToTifAction

public DsmToTifAction()

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.