File Out POP
Summary[edit]
The File Out POP allows you to write out POP contents to different file types. This includes point / geometry and scene file types.
You can record a sequence of .obj or .exr files by setting the Type parameter to File Sequence. You can press Record, and then only start to create files when Pause is set to off, or record (create) a single file at a time with the Add Frame pulse parameter.
It will try to output all the point, vertex and primitive attributes. Cases where it will not:
Some file formats have fixed attributes that File Out POP look for such as the SPZ and OBJ file format. While other files allow arbitrary attribute writing such as the EXR and PLY file format.
TBD: obj files: What is written to the file: What not written:
FPS determines the number of files to output per second of the timeline.
Parameters - File Out Page
type - ⊞ - Choose to output to a single file per Record/Add, or a sequentially-named sequence of files while it is recording.
- File
file- Records a single file.
- File Sequence
filesequence- Records a sequence of files.
scenefiletype - ⊞ - The Alembic Scene file type.
- Alembic
abc-
objectfiletype - ⊞ - The object file format type.
- OBJ
obj-
- EXR
exr-
- PLY
ply-
- SPZ
spz-
- E57
e57-
uniquesuff - When enabled, me.fileSuffix will be a unique suffix when used in the file parameter.
n - N is the index used in me.fileSuffix. When unique suffix is enabled, N specifies the starting index to increment from when calculating a unique suffix/name.
leadingzerosdigits - Specify the minimum number of suffix digits that the filename will have. If the sequence number is less than this number, leading zeros will be appended to total the number of suffix digits to be this value. Enabled only for File Sequences.
file - Sets the path and filename of the movie file that is saved out. The filename must include the file extension such as .obj/.exr etc.
limitlength - This can be used to automatically stop recording the file once it reaches a specified length.
length - ⊞ - The length to stop recording the file at.
- Length
length-
- Length Unit
lengthunit- Help Not Available.
record - When this parameter is set to 1, the file will be recording.
pause - Pauses the recording.
addframe - Adds a single frame to the output for each click of the button. Pause must be On to enable the Add Frame parameter.
maxactive - Specifies the maximum number of file saving tasks can be running at once.
includeprim - This can be used to enable writing primtive data to the file.
texcoordattrib - When writing out to geometry files including texture coordinates, the name of the texture attribute to use (doesn't have to be Tex).
attr - Start of Sequential Parameter Blocks to create fields in the file from attributes.
attr0name - Determines additional fields that can be created from attributes.
attr0fields - Determines additional fields that can be created from attributes.
outputcolorspace - ⊞ - Override / set the color space, or use the color space in the file, or assume default if there is none.
- sRGB
srgb-
- sRGB - Linear
srgblinear-
- Rec.601 (NTSC)
rec601ntsc-
- Rec.709
rec709-
- Rec.2020
rec2020-
- Rec.2020 ST2084PQ
rec2020st2084pq-
- Rec.2020 HLG
rec2020hlg-
- DCI-P3
dcip3-
- DCI-P3 (D60)
dcip3d60-
- Display P3 (D65)
displayp3d65-
- ACES2065-1
aces2065-1-
- ACEScg
acescg-
- ACESproxy
acesproxy-
- Passthrough
passthrough-
Parameters - Common Page
bypass - Pass through the first input to the output unchanged.
freeextragpumem - Free memory that has accumulated when output memory has grown and shrunk.
delinputattrs - Only output which attributes you specify in this POP - helps isolate attributes into a separate branch.
parmcolorspace - ⊞ - Controls how all color parameters on this node are interpreted. The color values as treated as being in the selected color space, and are converted to the Working Color Space before they are used as part of the node's operation. Note that this does not change the color space of the node itself, as that is always in the Working Color Space.
- sRGB
srgb- sRGB color space, with sRGB transfer function. Considered an SDR color space with respect to Reference White.
- sRGB - Linear
srgblinear- sRGB color space, with linear transfer function. Considered an SDR color space with respect to Reference White.
- Rec.601 (NTSC)
rec601ntsc- Rec.601 with NTSC primaries color space, with Rec.601 transfer function. Considered an SDR color space with respect to Reference White.
- Rec.709
rec709- Rec.709 color space, with Rec.709 (same as Rec.2020) transfer function. Considered an SDR color space with respect to Reference White.
- Rec.2020
rec2020- Rec.2020 color space, with Rec.2020 (same as Rec.709) transfer function. Considered an HDR color space with respect to Reference White.
- DCI-P3
dcip3- DCI-P3 color space, with D65 white point and 2.6 gamma transfer function. Considered an HDR color space with respect to Reference White.
- DCI-P3 (D60)
dcip3d60- DCI-P3 "D60 sim" color space, with D60 white point, and 2.6 gamma transfer function. Considered an HDR color space with respect to Reference White.
- Display-P3 (D65)
displayp3d65- Display-P3 color space, with D65 white point, and sRGB gamma transfer function. Considered an HDR color space with respect to Reference White.
- ACES2065-1
aces2065-1- ACES 2065-1 (also known as ACES AP0) color space, with a linear gamma transfer function. Considered an HDR color space with respect to Reference White.
- ACEScg
acescg- ACEScg (also known as ACES AP1) color space, with a linear gamma transfer function. Considered an HDR color space with respect to Reference White.
- Passthrough
passthrough- When selected, the color values will be used as-is in the operation, without any modification or attempt to convert them into the Working Color Space.
parmreferencewhite - ⊞ - When converting a parameter color value to the Working Color Space, this controls how it should be treated with respect to Reference White. If the Working Color Space is the same Reference White, then no adjustment is done. If they are different, then the Reference White level (brightness) of this color will be adjusted to the range expected by the Working Color Space. For example if the project is set to have a SDR Reference White of 120 nits, and the HDR Reference White is 80 nits, then a color of (1, 1, 1), which is 120 nits in the SDR color space, will be converted to be (1.5, 1.5, 1.5), which is 120 nits still in the HDR Working Color Space.
- Default For Color Space
default- Will use either the SDR or the HDR Reference White, based on the color space selected.
- Use Parent Panel
useparent- Will use the Reference White that the parent panel has selected. If the top-level panel also has 'Use Parent' selected, then 'UI Reference White' will be used.
- Standard (SDR)
sdr- Will treat the Parameter Color Space as SDR for it's reference white value.
- High (HDR)
hdr- Will treat the Parameter Color Space as HDR for it's reference white value.
- UI
ui- Will treat the Parameter Color Space as UI for it's reference white value. This uses the 'UI Reference White Nits' value for it's brightness.
Operator Inputs
- Input 0: -
Info CHOP Channels
Extra Information for the Box POP can be accessed via an Info CHOP.
Common POP Info Channels
Common Operator Info Channels
- total_cooks - Number of times the operator has cooked since the process started.
- cook_time - Duration of the last cook in milliseconds.
- cook_frame - Frame number when this operator was last cooked relative to the component timeline.
- cook_abs_frame - Frame number when this operator was last cooked relative to the absolute time.
- cook_start_time - Time in milliseconds at which the operator started cooking in the frame it was cooked.
- cook_end_time - Time in milliseconds at which the operator finished cooking in the frame it was cooked.
- cooked_this_frame - 1 if operator was cooked this frame.
- warnings - Number of warnings in this operator if any.
- errors - Number of errors in this operator if any.
TouchDesigner Build:
| POPs |
|---|
| • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • • |