OutputPlaceholder
ClassProvides output data from the neural network used by an MLComponent.
- Available on all platforms
Provides output data from the neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.
Index
Properties
Methods
Example
//@input Component.MLComponent mlComponent
//@input string outputName = "output"
var outputData;
script.mlComponent.onLoadingFinished = onLoadingFinished;
function onLoadingFinished() {
var output = script.mlComponent.getOutput(script.outputName);
outputData = output.data;
}
function onUpdate() {
// do something with data
}
Extends
Properties
data
readonlydata:Float32Array
Exposes user data
Output as a Float32Array. Usable when mode is set to MachineLearning.OutputMode.Data.
dataLayout
dataLayout:
DataLayout
The data layout of the current BasePlaceholder, which defines the order in which multidimensional data is accessed in memory.
Since
Lens Scripting Version 310
Default Value
MachineLearning.DataLayout.NHWC
Inherited from
internalDataLayout
readonlyinternalDataLayout:DataLayout
The internal data layout of the current BasePlaceholder. This layout is used by ML backend. If dataLayout is not the same as internalDataLayout, a layout conversion will happen when process model’s input/output.
Since
Lens Scripting Version 310
Inherited from
BasePlaceholder.internalDataLayout
mode
mode:
OutputMode
Which type of data the output is provided as. For example, Texture or Data.
Default Value
MachineLearning.OutputMode.Data
name
readonlyname:string
The name of the Placeholder.
Inherited from
shape
readonlyshape:vec3
The shape of the Placeholder's data.
Inherited from
texture
readonlytexture:Texture
Output as a Texture. Usable when mode is set to MachineLearning.OutputMode.Texture.
transformer
readonlytransformer:Transformer
Transformer object for applying transformations on the PlaceHolder's data.
Inherited from
Methods
getTypeName()
staticgetTypeName():TypeName<OutputPlaceholder>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<OutputPlaceholder>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean