From 16689174ee7a0465be6762535b8420667afcd589 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20Devernay?= Date: Fri, 17 Feb 2017 09:36:11 +0100 Subject: [PATCH] update docs --- Documentation/source/_groupTransform.rst | 1 + .../plugins/fr.inria.openfx.ReadFFmpeg.rst | 4 + .../plugins/fr.inria.openfx.ReadOIIO.rst | 4 +- .../plugins/fr.inria.openfx.WriteFFmpeg.rst | 32 +-- .../plugins/fr.inria.openfx.WriteOIIO.rst | 4 +- .../source/plugins/net.sf.openfx.Card3D.rst | 269 ++++++++++++++++++ .../net.sf.openfx.CheckerBoardPlugin.rst | 2 + .../plugins/net.sf.openfx.ColorBars.rst | 2 + .../plugins/net.sf.openfx.ColorWheel.rst | 2 + .../plugins/net.sf.openfx.ConstantPlugin.rst | 2 + .../plugins/net.sf.openfx.CropPlugin.rst | 58 ++-- .../plugins/net.sf.openfx.DenoiseSharpen.rst | 228 +++++++-------- .../plugins/net.sf.openfx.NoOpPlugin.rst | 2 + .../source/plugins/net.sf.openfx.Noise.rst | 2 + .../source/plugins/net.sf.openfx.Radial.rst | 2 + .../plugins/net.sf.openfx.Rectangle.rst | 2 + .../source/plugins/net.sf.openfx.Reformat.rst | 8 +- .../source/plugins/net.sf.openfx.Solid.rst | 2 + 18 files changed, 460 insertions(+), 166 deletions(-) create mode 100644 Documentation/source/plugins/net.sf.openfx.Card3D.rst diff --git a/Documentation/source/_groupTransform.rst b/Documentation/source/_groupTransform.rst index e1f2f7e100..cc4d0bba53 100644 --- a/Documentation/source/_groupTransform.rst +++ b/Documentation/source/_groupTransform.rst @@ -7,6 +7,7 @@ The following sections contain documentation about every node in the Transform :maxdepth: 1 plugins/net.sf.openfx.AdjustRoDPlugin.rst + plugins/net.sf.openfx.Card3D.rst plugins/net.sf.openfx.CornerPinPlugin.rst plugins/net.sf.openfx.CornerPinMaskedPlugin.rst plugins/net.sf.openfx.CropPlugin.rst diff --git a/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst b/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst index 561089b2cc..278cf0974a 100644 --- a/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst +++ b/Documentation/source/plugins/fr.inria.openfx.ReadFFmpeg.rst @@ -12,6 +12,10 @@ Description Read video using FFmpeg. +All formats supported by FFmpeg should be supported, but there may be issues with some non-conform files. In this case, it is recommended to transcode the video to a digital intermediate format, which is more suitable for grading, compositing and video editing. + +This can be done using the ffmpeg command-line tool, by following the instructions at https://trac.ffmpeg.org/wiki/Encode/VFX + FFmpeg versions (compiled with / running with): libavformat 57.56.100 / 57.56.100 diff --git a/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst b/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst index 3e6b3dc07f..5415d2f267 100644 --- a/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst +++ b/Documentation/source/plugins/fr.inria.openfx.ReadOIIO.rst @@ -66,9 +66,9 @@ All supported formats and extensions: bmp: bmp; cineon: cin; dds: dds; dpx: dpx; OIIO versions: -compiled with 1.7.10 +compiled with 1.7.11 -running with 1.7.10 +running with 1.7.11 Inputs ------ diff --git a/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst b/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst index c6193bb7d5..821a4a11c0 100644 --- a/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst +++ b/Documentation/source/plugins/fr.inria.openfx.WriteFFmpeg.rst @@ -18,21 +18,17 @@ The recommended Container/Codec configurations for encoding digital intermediate - QuickTime with ProRes: all ProRes profiles are 10-bit and are intra-frame (each frame is encoded separately). Prores 4444 can also encode the alpha channel. -- MXF or QuickTime with VC3/DNxHD/DNxHR: the codec is intra-frame. DNxHR profiles are resolution-independent, but are still only available with 8-bit depth. The alpha channel cannot be encoded. +- QuickTime with VC3/DNxHD/DNxHR: the codec is intra-frame. DNxHR profiles are resolution-independent, but are still only available with 8-bit depth. The alpha channel cannot be encoded. -- QuickTime with Photo JPEG and Global Quality set to 1: intra-frame and 8-bit. qscale=1 ensure almost lossless encoding. +- MP4 (or QuickTime) with Photo JPEG and Global Quality set to 1: intra-frame and 8-bit. qscale=1 ensure almost lossless encoding. -- QuickTime with avc1 (libx264 or libx264rgb) and Output Quality set to Lossless or Perceptually Lossless: 8-bit, and can be made intra-frame by setting Keyframe Interval to 1 and Max B-Frames to 0. Lossless may not be playable in real-time for high resolutions. Set the Encoding Speed to Ultra Fast for faster encoding but worse compression, or Very Slow for best compression. +- MP4 (or QuickTime) with avc1 (libx264 or libx264rgb) and Output Quality set to Lossless or Perceptually Lossless: 8-bit, and can be made intra-frame by setting Keyframe Interval to 1 and Max B-Frames to 0. Lossless may not be playable in real-time for high resolutions. Set the Encoding Speed to Ultra Fast for faster encoding but worse compression, or Very Slow for best compression. -To produce videos for distribution, the most popular codecs are mp4v (mpeg4 or libxvid), avc1 (libx264), hev1 (libx265), VP80 (libvpx) and VP90 (libvpx-vp9). The quality of mp4v may be set using the Global Quality parameter (between 1 and 31, 1 being the highest quality), and the quality of avc1, hev1, VP80 and VP90 may be set using the Output Quality parameter. More information can be found at https://trac.ffmpeg.org/wiki#Encoding +To write videos intended for distribution (as media files or for streaming), the most popular codecs are mp4v (mpeg4 or libxvid), avc1 (libx264), hev1 (libx265), VP80 (libvpx) and VP90 (libvpx-vp9). The quality of mp4v may be set using the Global Quality parameter (between 1 and 31, 1 being the highest quality), and the quality of avc1, hev1, VP80 and VP90 may be set using the Output Quality parameter. More information can be found at https://trac.ffmpeg.org/wiki#Encoding Adding audio -If audio is available as a separate file, encoded with the right codec, it can be easily added to the video using a command like: - -:: - - ffmpeg \-i input\.mp4 \-i input\.mp3 \-c copy \-map 0:0 \-map 1:0 output\.mp4 +If synchronized audio is available as a separate file, encoded with the right codec, it can be easily added to the video using a command like: ffmpeg -i input.mp4 -i input.mp3 -c copy -map 0:0 -map 1:0 output.mp4 (in this example, input.mp4 contains the video, input.mp3 contains the audio, and output.mp4 co,ntains both tracks). This command does not re-encode the video or audio, but simply copies the data from each source file and places it in separate streams in the output. @@ -199,12 +195,11 @@ Controls | Container / ``format`` | Choice | guess from filename | | Output format/container. | | | | | | **AVI (Audio Video Interleaved) [avi]**: Compatible with ayuv, cinepak, ffv1, ffvhuff, flv, huffyuv, jpeg2000, jpegls, ljpeg, mjpeg, mpeg2video, mpeg4, msmpeg4v2, msmpeg4, png, rawvideo, svq1, targa, v308, v408, v410, vc2, libopenjpeg, libschroedinger, libtheora, libvpx, libvpx-vp9, libx264, libx264rgb, libxvid. | | | | | | **FLV (Flash Video) [flv]**: Compatible with flv, mpeg4, libx264, libx264rgb, libxvid. | -| | | | | **Matroska [matroska]**: Compatible with prores\_ksap4h, prores\_ksapch, prores\_ksapcn, prores\_ksapcs, prores\_ksapco, mjpeg, mpeg2video, mpeg4, msmpeg4, rawvideo, vc2, libschroedinger, libtheora, libvpx, libvpx-vp9, libx264, libx264rgb, libxvid. | -| | | | | **QuickTime / MOV [mov]**: Compatible with prores\_ksap4h, prores\_ksapch, prores\_ksapcn, prores\_ksapcs, prores\_ksapco, avrp, cinepak, dnxhd, jpeg2000, mjpeg, mpeg2video, mpeg4, msmpeg4, png, qtrle, rawvideo, svq1, targa, tiff, v308, v408, v410, vc2, libopenjpeg, libschroedinger, libvpx-vp9, libx264, libx264rgb, libxvid. | -| | | | | **MP4 (MPEG-4 Part 14) [mp4]**: Compatible with jpeg2000, mjpeg, mpeg2video, mpeg4, png, vc2, libopenjpeg, libschroedinger, libvpx-vp9, libx264, libx264rgb, libxvid. | +| | | | | **Matroska [matroska]**: Compatible with prores\_ksap4h, prores\_ksapch, prores\_ksapcn, prores\_ksapcs, prores\_ksapco, mjpeg, mpeg2video, mpeg4, msmpeg4, rawvideo, vc2, libschroedinger, libtheora, libvpx, libvpx-vp9, libx264, libx264rgb, libx265, libxvid. | +| | | | | **QuickTime / MOV [mov]**: Compatible with prores\_ksap4h, prores\_ksapch, prores\_ksapcn, prores\_ksapcs, prores\_ksapco, avrp, cinepak, dnxhd, jpeg2000, mjpeg, mpeg2video, mpeg4, msmpeg4, png, qtrle, rawvideo, svq1, targa, tiff, v308, v408, v410, vc2, libopenjpeg, libschroedinger, libvpx-vp9, libx264, libx264rgb, libx265, libxvid. | +| | | | | **MP4 (MPEG-4 Part 14) [mp4]**: Compatible with jpeg2000, mjpeg, mpeg2video, mpeg4, png, vc2, libopenjpeg, libschroedinger, libvpx-vp9, libx264, libx264rgb, libx265, libxvid. | | | | | | **MPEG-1 Systems / MPEG program stream [mpeg]**: Compatible with libx264, libx264rgb. | -| | | | | **MPEG-TS (MPEG-2 Transport Stream) [mpegts]**: Compatible with mpeg2video, mpeg4, vc2, libschroedinger, libx264, libx264rgb, libxvid. | -| | | | | **MXF (Material eXchange Format) [mxf]**: Compatible with dnxhd, mpeg2video, libx264, libx264rgb. | +| | | | | **MPEG-TS (MPEG-2 Transport Stream) [mpegts]**: Compatible with mpeg2video, mpeg4, vc2, libschroedinger, libx264, libx264rgb, libx265, libxvid. | | | | | | **Ogg Video [ogv]**: Compatible with libtheora. | | | | | | **3GP2 (3GPP2 file format) [3g2]**: Compatible with mpeg4, libx264, libx264rgb, libxvid. | | | | | | **3GP (3GPP file format) [3gp]**: Compatible with mpeg4, libx264, libx264rgb, libxvid. | @@ -220,7 +215,7 @@ Controls | | | | | **AVrp Avid 1:1 10-bit RGB Packer [avrp]**: Compatible with mov. | | | | | | **AYUV Uncompressed packed MS 4:4:4:4 [ayuv]**: Compatible with avi. | | | | | | **cvid Cinepak [cinepak]**: Compatible with avi, mov. | -| | | | | **AVdn Avid DNxHD / DNxHR / SMPTE VC-3 [dnxhd]**: Compatible with mov, mxf. | +| | | | | **AVdn Avid DNxHD / DNxHR / SMPTE VC-3 [dnxhd]**: Compatible with mov. | | | | | | **FFV1 FFmpeg video codec #1 [ffv1]**: Compatible with avi. | | | | | | **FFVH Huffyuv FFmpeg variant [ffvhuff]**: Compatible with avi. | | | | | | **FLV1 FLV / Sorenson Spark / Sorenson H.263 (Flash Video) [flv]**: Compatible with avi, flv. | @@ -229,7 +224,7 @@ Controls | | | | | **MJLS JPEG-LS [jpegls]**: Compatible with avi. | | | | | | **LJPG Lossless JPEG [ljpeg]**: Compatible with avi. | | | | | | **jpeg Photo JPEG [mjpeg]**: Compatible with avi, matroska, mov, mp4. | -| | | | | **m2v1 MPEG-2 Video [mpeg2video]**: Compatible with avi, matroska, mov, mp4, mpegts, mxf. | +| | | | | **m2v1 MPEG-2 Video [mpeg2video]**: Compatible with avi, matroska, mov, mp4, mpegts. | | | | | | **mp4v MPEG-4 part 2 [mpeg4]**: Compatible with avi, flv, matroska, mov, mp4, mpegts, 3g2, 3gp. | | | | | | **MP42 MPEG-4 part 2 Microsoft variant version 2 [msmpeg4v2]**: Compatible with avi. | | | | | | **3IVD MPEG-4 part 2 Microsoft variant version 3 [msmpeg4]**: Compatible with avi, matroska, mov. | @@ -248,8 +243,9 @@ Controls | | | | | **theo Theora [libtheora]**: Compatible with avi, matroska, ogv. | | | | | | **VP80 On2 VP8 [libvpx]**: Compatible with avi, matroska. | | | | | | **VP90 Google VP9 [libvpx-vp9]**: Compatible with avi, matroska, mov, mp4. | -| | | | | **avc1 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 [libx264]**: Compatible with avi, flv, matroska, mov, mp4, mpeg, mpegts, mxf, 3g2, 3gp. | -| | | | | **avc1 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 RGB [libx264rgb]**: Compatible with avi, flv, matroska, mov, mp4, mpeg, mpegts, mxf, 3g2, 3gp. | +| | | | | **avc1 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 [libx264]**: Compatible with avi, flv, matroska, mov, mp4, mpeg, mpegts, 3g2, 3gp. | +| | | | | **avc1 H.264 / AVC / MPEG-4 AVC / MPEG-4 part 10 RGB [libx264rgb]**: Compatible with avi, flv, matroska, mov, mp4, mpeg, mpegts, 3g2, 3gp. | +| | | | | **hev1 H.265 / HEVC (High Efficiency Video Coding) [libx265]**: Compatible with matroska, mov, mp4, mpegts. | | | | | | **mp4v MPEG-4 part 2 [libxvid]**: Compatible with avi, flv, matroska, mov, mp4, mpegts, 3g2, 3gp. | +--------------------------------------------------+-----------+--------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Codec Name / ``codecShortName`` | String |   | The codec used when the writer was configured. If this parameter is visible, this means that this codec may not be supported by this version of the plugin. | diff --git a/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst b/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst index 35f84b0c5e..65728a3db4 100644 --- a/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst +++ b/Documentation/source/plugins/fr.inria.openfx.WriteOIIO.rst @@ -56,9 +56,9 @@ All supported formats and extensions: bmp: bmp; cineon: cin; dds: dds; dpx: dpx; OIIO versions: -compiled with 1.7.10 +compiled with 1.7.11 -running with 1.7.10 +running with 1.7.11 Inputs ------ diff --git a/Documentation/source/plugins/net.sf.openfx.Card3D.rst b/Documentation/source/plugins/net.sf.openfx.Card3D.rst new file mode 100644 index 0000000000..f4a2f4a10b --- /dev/null +++ b/Documentation/source/plugins/net.sf.openfx.Card3D.rst @@ -0,0 +1,269 @@ +.. _net.sf.openfx.Card3D: + +Card3D node +=========== + +*This documentation is for version 1.0 of Card3D.* + +Description +----------- + +Card3D. + +This effect applies a transform that corresponds to projection the source image onto a 3D card in space. The 3D card is positionned with relative to the Axis position, and the Camera position may also be given. The Axis may be used to apply the same global motion to several cards. + +This plugin concatenates transforms. + +http://opticalenquiry.com/nuke/index.php?title=Card3D + +Inputs +------ + ++----------+---------------+------------+ +| Input | Description | Optional | ++==========+===============+============+ +| Source |   | No | ++----------+---------------+------------+ + +Controls +-------- + +.. tabularcolumns:: |>{\raggedright}p{0.2\columnwidth}|>{\raggedright}p{0.06\columnwidth}|>{\raggedright}p{0.07\columnwidth}|p{0.63\columnwidth}| + +.. cssclass:: longtable + ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Parameter / script name | Type | Default | Function | ++===============================================+===========+===================+===============================================================================================================================================================================================================================================================+ +| Transform Order / ``axisXformOrder`` | Choice | SRT | | Order in which scale (S), rotation (R) and translation (T) are applied. | +| | | | | **SRT**: Scale, Rotation, Translation. | +| | | | | **STR**: Scale, Translation, Rotation. | +| | | | | **RST**: Rotation, Scale, Translation. | +| | | | | **RTS**: Rotation, Translation, Scale. | +| | | | | **TSR**: Translation, Scale, Rotation. | +| | | | | **TRS**: Translation, Rotation, Scale. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotation Order / ``axisRotOrder`` | Choice | ZXY | Order in which Euler angles are applied in the rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Translate / ``axisTranslate`` | Double | x: 0 y: 0 z: 0 | Translation component. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotate / ``axisRotate`` | Double | x: 0 y: 0 z: 0 | Euler angles (in degrees). | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Scale / ``axisScaling`` | Double | x: 1 y: 1 z: 1 | Scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Uniform Scale / ``axisUniformScale`` | Double | 1 | Scale factor over all axis. It is multiplied by the scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Skew / ``axisSkew`` | Double | x: 0 y: 0 z: 0 | Skew over each axis, in degrees. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pivot / ``axisPivot`` | Double | x: 0 y: 0 z: 0 | The position of the origin for position, scaling, skewing, and rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Specify Matrix / ``axisUseMatrix`` | Boolean | Off | Check to specify manually all the values for the position matrix. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix11`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix12`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix13`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix14`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix21`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix22`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix23`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix24`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix31`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix32`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix33`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix34`` | Double | -1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix41`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix42`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix43`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``axisMatrix44`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Enable Camera / ``camEnable`` | Boolean | Off | Enable the camera projection parameters. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Transform Order / ``camXformOrder`` | Choice | SRT | | Order in which scale (S), rotation (R) and translation (T) are applied. | +| | | | | **SRT**: Scale, Rotation, Translation. | +| | | | | **STR**: Scale, Translation, Rotation. | +| | | | | **RST**: Rotation, Scale, Translation. | +| | | | | **RTS**: Rotation, Translation, Scale. | +| | | | | **TSR**: Translation, Scale, Rotation. | +| | | | | **TRS**: Translation, Rotation, Scale. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotation Order / ``camRotOrder`` | Choice | ZXY | Order in which Euler angles are applied in the rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Translate / ``camTranslate`` | Double | x: 0 y: 0 z: 0 | Translation component. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotate / ``camRotate`` | Double | x: 0 y: 0 z: 0 | Euler angles (in degrees). | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Scale / ``camScaling`` | Double | x: 1 y: 1 z: 1 | Scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Uniform Scale / ``camUniformScale`` | Double | 1 | Scale factor over all axis. It is multiplied by the scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Skew / ``camSkew`` | Double | x: 0 y: 0 z: 0 | Skew over each axis, in degrees. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pivot / ``camPivot`` | Double | x: 0 y: 0 z: 0 | The position of the origin for position, scaling, skewing, and rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Specify Matrix / ``camUseMatrix`` | Boolean | Off | Check to specify manually all the values for the position matrix. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix11`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix12`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix13`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix14`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix21`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix22`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix23`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix24`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix31`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix32`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix33`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix34`` | Double | -1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix41`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix42`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix43`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``camMatrix44`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Projection / ``camprojection_mode`` | Choice | Perspective |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Focal Length / ``camfocal`` | Double | 50 |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Horiz. Aperture / ``camhaperture`` | Double | 24.576 |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Window Translate / ``camwin_translate`` | Double | x: 0 y: 0 |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Window Scale / ``camwin_scale`` | Double | x: 1 y: 1 |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Window Roll / ``camwinroll`` | Double | 0 |   | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Transform Order / ``cardXformOrder`` | Choice | SRT | | Order in which scale (S), rotation (R) and translation (T) are applied. | +| | | | | **SRT**: Scale, Rotation, Translation. | +| | | | | **STR**: Scale, Translation, Rotation. | +| | | | | **RST**: Rotation, Scale, Translation. | +| | | | | **RTS**: Rotation, Translation, Scale. | +| | | | | **TSR**: Translation, Scale, Rotation. | +| | | | | **TRS**: Translation, Rotation, Scale. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotation Order / ``cardRotOrder`` | Choice | ZXY | Order in which Euler angles are applied in the rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Translate / ``cardTranslate`` | Double | x: 0 y: 0 z: -1 | Translation component. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Rotate / ``cardRotate`` | Double | x: 0 y: 0 z: 0 | Euler angles (in degrees). | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Scale / ``cardScaling`` | Double | x: 1 y: 1 z: 1 | Scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Uniform Scale / ``cardUniformScale`` | Double | 1 | Scale factor over all axis. It is multiplied by the scale factor over each axis. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Skew / ``cardSkew`` | Double | x: 0 y: 0 z: 0 | Skew over each axis, in degrees. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Pivot / ``cardPivot`` | Double | x: 0 y: 0 z: 0 | The position of the origin for position, scaling, skewing, and rotation. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Specify Matrix / ``cardUseMatrix`` | Boolean | Off | Check to specify manually all the values for the position matrix. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix11`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix12`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix13`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix14`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix21`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix22`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix23`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix24`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix31`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix32`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix33`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix34`` | Double | -1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix41`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix42`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix43`` | Double | 0 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +|   / ``cardMatrix44`` | Double | 1 | Matrix coefficient. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Lens-In Focal / ``lensInFocal`` | Double | 1 | The focal length of the camera that took the picture on the card. The card is scaled so that at distance 1 (which is the default card Z) it occupies the field of view corresponding to lensInFocal and lensInHAperture. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Lens-In H.Aperture / ``lensInHAperture`` | Double | 1 | The horizontal aperture (or sensor/film back width) of the camera that took the picture on the card. The card is scaled so that at distance 1 (which is the default card Z) it occupies the field of view corresponding to lensInFocal and lensInHAperture. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Output Format / ``format`` | Choice | Project | | Desired format for the output sequence. | +| | | | | **Format**: Use a pre-defined image format. | +| | | | | **Size**: Use a specific extent (size and offset). | +| | | | | **Project**: Use the project extent (size and offset). | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Size / ``size`` | Double | w: 1 h: 1 | Width and height of the size rectangle. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Invert / ``invert`` | Boolean | Off | Invert the transform. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Filter / ``filter`` | Choice | Cubic | | Filtering algorithm - some filters may produce values outside of the initial range (\*) or modify the values even if there is no movement (+). | +| | | | | **Impulse**: (nearest neighbor / box) Use original values | +| | | | | **Bilinear**: (tent / triangle) Bilinear interpolation between original values | +| | | | | **Cubic**: (cubic spline) Some smoothing | +| | | | | **Keys**: (Catmull-Rom / Hermite spline) Some smoothing, plus minor sharpening (\*) | +| | | | | **Simon**: Some smoothing, plus medium sharpening (\*) | +| | | | | **Rifman**: Some smoothing, plus significant sharpening (\*) | +| | | | | **Mitchell**: Some smoothing, plus blurring to hide pixelation (\*+) | +| | | | | **Parzen**: (cubic B-spline) Greatest smoothing of all filters (+) | +| | | | | **Notch**: Flat smoothing (which tends to hide moire' patterns) (+) | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Clamp / ``clamp`` | Boolean | Off | Clamp filter output within the original range - useful to avoid negative values in mattes | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Black outside / ``black_outside`` | Boolean | On | Fill the area outside the source image with black | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Motion Blur / ``motionBlur`` | Double | 0 | Quality of motion blur rendering. 0 disables motion blur, 1 is a good value. Increasing this slows down rendering. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Directional Blur Mode / ``directionalBlur`` | Boolean | Off | Motion blur is computed from the original image to the transformed image, each parameter being interpolated linearly. The motionBlur parameter must be set to a nonzero value, and the blackOutside parameter may have an important effect on the result. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Shutter / ``shutter`` | Double | 0.5 | Controls how long (in frames) the shutter should remain open. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Shutter Offset / ``shutterOffset`` | Choice | Start | | Controls when the shutter should be open/closed. Ignored if there is no motion blur (i.e. shutter=0 or motionBlur=0). | +| | | | | **Centered**: Centers the shutter around the frame (from t-shutter/2 to t+shutter/2) | +| | | | | **Start**: Open the shutter at the frame (from t to t+shutter) | +| | | | | **End**: Close the shutter at the frame (from t-shutter to t) | +| | | | | **Custom**: Open the shutter at t+shuttercustomoffset (from t+shuttercustomoffset to t+shuttercustomoffset+shutter) | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Custom Offset / ``shutterCustomOffset`` | Double | 0 | When custom is selected, the shutter is open at current time plus this offset (in frames). Ignored if there is no motion blur (i.e. shutter=0 or motionBlur=0). | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Interactive Update / ``interactive`` | Boolean | Off | If checked, update the parameter values during interaction with the image viewer, else update the values when pen is released. | ++-----------------------------------------------+-----------+-------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst b/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst index 8afd241cba..b5f0c7232d 100644 --- a/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst +++ b/Documentation/source/plugins/net.sf.openfx.CheckerBoardPlugin.rst @@ -43,6 +43,8 @@ Controls +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+-----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.ColorBars.rst b/Documentation/source/plugins/net.sf.openfx.ColorBars.rst index 10d14f7a3c..7523959a9c 100644 --- a/Documentation/source/plugins/net.sf.openfx.ColorBars.rst +++ b/Documentation/source/plugins/net.sf.openfx.ColorBars.rst @@ -43,6 +43,8 @@ Controls +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+-----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst b/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst index 7f1183a42b..36ebaeb4d2 100644 --- a/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst +++ b/Documentation/source/plugins/net.sf.openfx.ColorWheel.rst @@ -43,6 +43,8 @@ Controls +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst b/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst index 2c2f86196e..ca04e7d2ca 100644 --- a/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst +++ b/Documentation/source/plugins/net.sf.openfx.ConstantPlugin.rst @@ -41,6 +41,8 @@ Controls +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.CropPlugin.rst b/Documentation/source/plugins/net.sf.openfx.CropPlugin.rst index aea6e47a1d..cf10c1627b 100644 --- a/Documentation/source/plugins/net.sf.openfx.CropPlugin.rst +++ b/Documentation/source/plugins/net.sf.openfx.CropPlugin.rst @@ -32,35 +32,35 @@ Controls .. cssclass:: longtable -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter / script name | Type | Default | Function | -+========================================+===========+=================+==============================================================================================================================================================+ -| Extent / ``extent`` | Choice | Size | | Extent (size and offset) of the output. | -| | | | | **Format**: Use a pre-defined image format. | -| | | | | **Size**: Use a specific extent (size and offset). | -| | | | | **Project**: Use the project extent (size and offset). | -| | | | | **Default**: Use the default extent (e.g. the source clip extent, if connected). | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Size / ``size`` | Double | w: 1 h: 1 | Width and height of the size rectangle. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Interactive Update / ``interactive`` | Boolean | Off | If checked, update the parameter values during interaction with the image viewer, else update the values when pen is released. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Frame Range / ``frameRange`` | Integer | min: 1 max: 1 | Time domain. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Softness / ``softness`` | Double | 0 | Size of the fade to black around edges to apply. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Reformat / ``reformat`` | Boolean | Off | Translates the bottom left corner of the crop rectangle to be in (0,0). | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Intersect / ``intersect`` | Boolean | Off | Intersects the crop rectangle with the input region of definition instead of extending it. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Black Outside / ``blackOutside`` | Boolean | Off | Add 1 black and transparent pixel to the region of definition so that all the area outside the crop rectangle is black. | -+----------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Parameter / script name | Type | Default | Function | ++========================================+===========+=================+================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| Extent / ``extent`` | Choice | Size | | Extent (size and offset) of the output. | +| | | | | **Format**: Use a pre-defined image format. | +| | | | | **Size**: Use a specific extent (size and offset). | +| | | | | **Project**: Use the project extent (size and offset). | +| | | | | **Default**: Use the default extent (e.g. the source clip extent, if connected). | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Translates the bottom left corner of the crop rectangle to be in (0,0). This sets the output format only if 'Format' or 'Project' is selected as the output Extend. In order to actually change the format of this image stream for other Extent choices, feed the output of this node to a either a NoOp node which sets the proper format, or a Reformat node with the same extent and with 'Resize Type' set to None and 'Center' unchecked. The reason is that the Crop size may be animated, but the output format can not be animated. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Size / ``size`` | Double | w: 1 h: 1 | Width and height of the size rectangle. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Interactive Update / ``interactive`` | Boolean | Off | If checked, update the parameter values during interaction with the image viewer, else update the values when pen is released. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Frame Range / ``frameRange`` | Integer | min: 1 max: 1 | Time domain. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Softness / ``softness`` | Double | 0 | Size of the fade to black around edges to apply. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Intersect / ``intersect`` | Boolean | Off | Intersects the crop rectangle with the input region of definition instead of extending it. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Black Outside / ``blackOutside`` | Boolean | Off | Add 1 black and transparent pixel to the region of definition so that all the area outside the crop rectangle is black. | ++----------------------------------------+-----------+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. |pluginIcon| image:: net.sf.openfx.CropPlugin.png :width: 10.0% diff --git a/Documentation/source/plugins/net.sf.openfx.DenoiseSharpen.rst b/Documentation/source/plugins/net.sf.openfx.DenoiseSharpen.rst index f1fd67bb91..6d9e593a80 100644 --- a/Documentation/source/plugins/net.sf.openfx.DenoiseSharpen.rst +++ b/Documentation/source/plugins/net.sf.openfx.DenoiseSharpen.rst @@ -15,7 +15,7 @@ Description This plugin allows the separate denoising of image channels in multiple color spaces using wavelets, using the BayesShrink algorithm, and can also sharpen the image details. -Noise levels for each channel may be either set manually, or analyzed from the image data in each wavelet subband using the MAD (median absolute deviation) estimator. Noise analysis is based on a Gaussian noise assumption. If there is speckle noise in the images, the Median or SmoothPatchBased filters may be more appropriate. The color model specifies the channels and the transforms used. Noise levels have to be re-adjusted or re-analyzed when changing the color model. +Noise levels for each channel may be either set manually, or analyzed from the image data in each wavelet subband using the MAD (median absolute deviation) estimator. Noise analysis is based on the assuption that the noise is Gaussian and additive (it is not intensity-dependent). If there is speckle or salt-and-pepper noise in the images, the Median or SmoothPatchBased filters may be more appropriate. The color model specifies the channels and the transforms used. Noise levels have to be re-adjusted or re-analyzed when changing the color model. Basic Usage ----------- @@ -25,18 +25,18 @@ The input image should be in linear RGB. For most footage, the effect works best by keeping the default Y'CbCr color model. The color models are made to work with Rec.709 data, but DenoiseSharpen will still work if the input is in another colorspace, as long as the input is linear RGB: - The Y'CbCr color model uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B' and the the Rec.709 primaries to convert from R'G'B' to Y'CbCr. -- The L\ *a*\ b color model uses the Rec.709 RGB primaries to convert from RGB to L\ *a*\ b.. +- The L \* a \* b color model uses the Rec.709 RGB primaries to convert from RGB to L \* a \* b. - The R'G'B' color model uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B'. -- The RGB color model (linear) makes no assumption about the RGB color space. +- The RGB color model (linear) makes no assumption about the RGB color space, and works directly on the RGB components, assuming additive noise. If, say, the noise is known to be multiplicative, one can convert the images to Log before denoising, use this option, and convert back to linear after denoising. - The Alpha channel, if processed, is always considered to be linear. The simplest way to use this plugin is to leave the noise analysis area to the whole image, and click "Analyze Noise Levels". Once the analysis is done, "Lock Noise Analysis" is checked in order to avoid modifying the essential parameters by mistake. -If the image has many textured areas, it may be preferable to select an analysis area with flat colors, free from any details, shadows or hightlights, to avoid considering texture as noise. The AnalysisMask input can be used to mask the analysis, if the rectangular area is not appropriate. +If the image has many textured areas, it may be preferable to select an analysis area with flat colors, free from any details, shadows or hightlights, to avoid considering texture as noise. The AnalysisMask input can be used to mask the analysis, if the rectangular area is not appropriate. Any non-zero pixels in the mask are taken into account. A good option for the AnalysisMask would be to take the inverse of the output of an edge detector and clamp it correctly so that all pixels near the edges have a value of zero.. -If the sequence to be denoised does not have enough flat areas, you can also connect a reference footage with the same kind of noise to the AnalysisSource input: that source will be used for the analysis only. If no source with flat areas is available, it is often preferable to disable very low, low, and sometimes medium frequencies in the "Frequency Tuning" parameters group, or at least to lower their gain, since they may be misestimated by the noise analysis process. If the noise is IID (independent and identically distributed), such as digital sensor noise, only "Denoise High Frequencies" should be checked. If the noise has some grain (i.e. it commes from lossy compression of noisy images by a camera, or it is scanned film), then you may want to enable medium frequencies as well. If low and very low frequencies are enabled, but the analysis area is not a flat zone, the signal itself (i.e. the noise-free image) could be considered as noise, and the result may exhibit low contrast and blur. +If the sequence to be denoised does not have enough flat areas, you can also connect a reference footage with the same kind of noise to the AnalysisSource input: that source will be used for the analysis only. If no source with flat areas is available, and noise analysis can only be performed on areas which also contain details, it is often preferable to disable very low, low, and sometimes medium frequencies in the "Frequency Tuning" parameters group, or at least to lower their gain, since they may be misestimated by the noise analysis process. If the noise is IID (independent and identically distributed), such as digital sensor noise, only "Denoise High Frequencies" should be checked. If the noise has some grain (i.e. it commes from lossy compression of noisy images by a camera, or it is scanned film), then you may want to enable medium frequencies as well. If low and very low frequencies are enabled, but the analysis area is not a flat zone, the signal itself (i.e. the noise-free image) could be considered as noise, and the result may exhibit low contrast and blur. -To check what details have been kept after denoising, you can raise the Sharpen Amount to something like 10, and then adjust the Noise Level Gain to get the desired denoising amount, until no noise is left. You can then reset the Sharpen Amount, unless you actually want to enhance the contrast of your denoised footage. +To check what details have been kept after denoising, you can raise the Sharpen Amount to something like 10, and then adjust the Noise Level Gain to get the desired denoising amount, until no noise is left and only image details remain in the sharpened image. You can then reset the Sharpen Amount to zero, unless you actually want to enhance the contrast of your denoised footage. You can also check what was actually removed from the original image by selecting the "Noise" Output mode (instead of "Result"). If too many image details are visible in the noise, noise parameters may need to be tuned. @@ -62,111 +62,111 @@ Controls .. cssclass:: longtable -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Parameter / script name | Type | Default | Function | -+========================================================+===========+=============+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ -| Output / ``outputMode`` | Choice | Result | | Select | -| | | | | **Result**: The result of denoising and sharpening the Source image. | -| | | | | **Noise**: An image containing what would be added to the image to denoise it. If 'Denoise Amount' is zero, this image should be black. Only noise should be visible in this image. If you can see a lot of picture detail in the noise output, it means the current settings are denoising too hard and remove too much of the image, which leads to a smoothed result. Try to lower the noise levels or the noise level gain. | -| | | | | **Sharpen**: An image containing what would be added to the image to sharpen it. If 'Sharpen Amount' is zero, this image should be black. Only image details should be visible in this image. If you can see a lot of noise in the sharpen output, it means the current settings are denoising not enough, which leads to a noisy result. Try to raise the noise levels or the noise level gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Color Model / ``colorModel`` | Choice | Y'CbCr(A) | | The colorspace where denoising is performed. These colorspaces assume that input and output use the Rec.709/sRGB chromaticities and the D65 illuminant, but should tolerate other input colorspaces (the output colorspace will always be the same as the input colorspace). Noise levels are reset when the color model is changed. | -| | | | | **Y'CbCr(A)**: The YCbCr color model has one luminance channel (Y) which contains most of the detail information of an image (such as brightness and contrast) and two chroma channels (Cb = blueness, Cr = reddness) that hold the color information. Note that this choice drastically affects the result. Uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B' and the the Rec.709 primaries to convert from R'G'B' to Y'CbCr. | -| | | | | **CIE L\*a\*b(A)**: CIE L\*a\*b\* is a color model in which chrominance is separated from lightness and color distances are perceptually uniform. Note that this choice drastically affects the result. Uses the Rec.709 primaries to convert from RGB to L\*a\*b. | -| | | | | **R'G'B'(A)**: The R'G'B' color model (gamma-corrected RGB) separates an image into channels of red, green, and blue. Note that this choice drastically affects the result. Uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B'. | -| | | | | **RGB(A)**: The Linear RGB color model processes the raw linear components. Usually a bad choice, except when denoising non-color data (e.g. depth or motion vectors). No assumption is made about the RGB color space. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Lock Noise Analysis / ``analysisLock`` | Boolean | Off | Lock all noise analysis parameters. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the analysis rectangle. This rectangle is intersected with the AnalysisMask input, if connected. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Size / ``size`` | Double | w: 1 h: 1 | Width and height of the analysis rectangle. This rectangle is intersected with the AnalysisMask input, if connected. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| B3 Spline Interpolation / ``useB3Spline`` | Boolean | On | For wavelet decomposition, use a 5x5 filter based on B3 spline interpolation rather than a 3x3 Lagrange linear filter. Noise levels are reset when this setting is changed. The influence of this parameter is minimal, and it should not be changed. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Analysis Frame / ``analysisFrame`` | Integer | -1 | The frame number where the noise levels were analyzed. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Analyze Noise Levels / ``analyzeNoiseLevels`` | Button |   | Computes the noise levels from the current frame and current color model. To use the same settings for the whole sequence, analyze a frame that is representative of the sequence. If a mask is set, it is used to compute the noise levels from areas where the mask is non-zero. If there are keyframes on the noise level parameters, this sets a keyframe at the current frame. The noise levels can then be fine-tuned. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Level (High) / ``ylrNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Level (High) / ``cbagNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Level (High) / ``crbbNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Level (High) / ``alphaNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Level (Medium) / ``ylrNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Level (Medium) / ``cbagNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Level (Medium) / ``crbbNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Level (Medium) / ``alphaNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Level (Low) / ``ylrNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Level (Low) / ``cbagNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Level (Low) / ``crbbNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Level (Low) / ``alphaNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Level (Very Low) / ``ylrNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Level (Very Low) / ``cbagNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Level (Very Low) / ``crbbNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Level (Very Low) / ``alphaNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Noise Level Gain / ``noiseLevelGain`` | Double | 1 | Global gain to apply to the noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the channel gain. The default value (1.0) is rather conservative (it does not destroy any kind of signal). Values around 1.1 or 1.2 usually give more pleasing results. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Denoise Amount / ``denoiseAmount`` | Double | 1 | The amount of denoising to apply. 0 means no denoising (which may be useful to sharpen without denoising), between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the per-channel amount se in the 'Channel Tuning' group. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Denoise High Frequencies / ``enableFreqHigh`` | Boolean | On | Check to enable the high frequency noise level thresholds. It is recommended to always leave this checked. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| High Gain / ``gainFreqHigh`` | Double | 1 | Gain to apply to the high frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Denoise Medium Frequencies / ``enableFreqMedium`` | Boolean | On | Check to enable the medium frequency noise level thresholds. Can be disabled if the analysis area contains high frequency texture, or if the the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Medium Gain / ``gainFreqMedium`` | Double | 1 | Gain to apply to the medium frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Denoise Low Frequencies / ``enableFreqLow`` | Boolean | On | Check to enable the low frequency noise level thresholds. Must be disabled if the analysis area contains texture, or if the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Low Gain / ``gainFreqLow`` | Double | 1 | Gain to apply to the low frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Denoise Very Low Frequencies / ``enableFreqVeryLow`` | Boolean | On | Check to enable the very low frequency noise level thresholds. Can be disabled in most cases. Must be disabled if the analysis area contains texture, or if the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Very Low Gain / ``gainFreqVeryLow`` | Double | 1 | Gain to apply to the very low frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the global Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Adaptive Radius / ``adaptiveRadius`` | Integer | 4 | Radius of the window where the signal level is analyzed at each scale. If zero, the signal level is computed from the whole image, which may excessively blur the edges if the image has many flat color areas. A reasonable value should to be in the range 2-4. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Gain / ``ylrGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Y Amount / ``ylrAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Gain / ``cbagGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cb Amount / ``cbagAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Gain / ``crbbGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Cr Amount / ``crbbAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Gain / ``alphaGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Alpha Amount / ``alphaAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Sharpen Amount / ``sharpenAmount`` | Double | 0 | Adjusts the amount of sharpening applied. Be careful that only components that are above the noise levels are enhanced, so the noise level gain parameters are very important for proper sharpening. For example, if 'Noise Level Gain' is set to zero (0), then noise is sharpened as well as signal. If the 'Noise Level Gain' is set to one (1), only signal is sharpened. In order to sharpen without denoising, set the 'Denoise Amount' parameter to zero (0). | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Sharpen Size / ``sharpenSize`` | Double | 10 | Adjusts the size of the sharpening. For very unsharp images it is recommended to use higher values. Default is 10. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Sharpen Y Only / ``sharpenLuminance`` | Boolean | On | Sharpens luminance only (if colormodel is R'G'B', sharpen only RGB). This avoids color artifacts to appear. Colour sharpness in natural images is not critical for the human eye. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| (Un)premult / ``premult`` | Boolean | Off | Divide the image by the alpha channel before processing, and re-multiply it afterwards. Use if the input images are premultiplied. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Invert Mask / ``maskInvert`` | Boolean | Off | When checked, the effect is fully applied where the mask is 0. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ -| Mix / ``mix`` | Double | 1 | Mix factor between the original and the transformed image. | -+--------------------------------------------------------+-----------+-------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Parameter / script name | Type | Default | Function | ++========================================================+===========+=================+==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================+ +| Output / ``outputMode`` | Choice | Result | | Select which image is output when analysis is locked. When analysis is not locked, the effect does nothing (the output is the source image). | +| | | | | **Result**: The result of denoising and sharpening the Source image. | +| | | | | **Noise**: An image containing what would be added to the image to denoise it. If 'Denoise Amount' is zero, this image should be black. Only noise should be visible in this image. If you can see a lot of picture detail in the noise output, it means the current settings are denoising too hard and remove too much of the image, which leads to a smoothed result. Try to lower the noise levels or the noise level gain. | +| | | | | **Sharpen**: An image containing what would be added to the image to sharpen it. If 'Sharpen Amount' is zero, this image should be black. Only image details should be visible in this image. If you can see a lot of noise in the sharpen output, it means the current settings are denoising not enough, which leads to a noisy result. Try to raise the noise levels or the noise level gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Color Model / ``colorModel`` | Choice | Y'CbCr(A) | | The colorspace where denoising is performed. These colorspaces assume that input and output use the Rec.709/sRGB chromaticities and the D65 illuminant, but should tolerate other input colorspaces (the output colorspace will always be the same as the input colorspace). Noise levels are reset when the color model is changed. | +| | | | | **Y'CbCr(A)**: The YCbCr color model has one luminance channel (Y) which contains most of the detail information of an image (such as brightness and contrast) and two chroma channels (Cb = blueness, Cr = reddness) that hold the color information. Note that this choice drastically affects the result. Uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B' and the the Rec.709 primaries to convert from R'G'B' to Y'CbCr. | +| | | | | **CIE L\*a\*b(A)**: CIE L\*a\*b\* is a color model in which chrominance is separated from lightness and color distances are perceptually uniform. Note that this choice drastically affects the result. Uses the Rec.709 primaries to convert from RGB to L\*a\*b. | +| | | | | **R'G'B'(A)**: The R'G'B' color model (gamma-corrected RGB) separates an image into channels of red, green, and blue. Note that this choice drastically affects the result. Uses the Rec.709 opto-electronic transfer function to convert from RGB to R'G'B'. | +| | | | | **RGB(A)**: The Linear RGB color model processes the raw linear components. Usually a bad choice, except when denoising non-color data (e.g. depth or motion vectors). No assumption is made about the RGB color space. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Lock Analysis and Apply / ``analysisLock`` | Boolean | Off | Lock all noise analysis parameters and apply denoising. When the analysis is not locked, the source image is output. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Bottom Left / ``bottomLeft`` | Double | x: 0.1 y: 0.1 | Coordinates of the bottom left corner of the analysis rectangle. This rectangle is intersected with the AnalysisMask input, if connected. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Size / ``size`` | Double | w: 0.8 h: 0.8 | Width and height of the analysis rectangle. This rectangle is intersected with the AnalysisMask input, if connected. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| B3 Spline Interpolation / ``useB3Spline`` | Boolean | On | For wavelet decomposition, use a 5x5 filter based on B3 spline interpolation rather than a 3x3 Lagrange linear filter. Noise levels are reset when this setting is changed. The influence of this parameter is minimal, and it should not be changed. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Analysis Frame / ``analysisFrame`` | Integer | -1 | The frame number where the noise levels were analyzed. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Analyze Noise Levels / ``analyzeNoiseLevels`` | Button |   | Computes the noise levels from the current frame and current color model. To use the same settings for the whole sequence, analyze a frame that is representative of the sequence. If a mask is set, it is used to compute the noise levels from areas where the mask is non-zero. If there are keyframes on the noise level parameters, this sets a keyframe at the current frame. The noise levels can then be fine-tuned. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Level (High) / ``ylrNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Level (High) / ``cbagNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Level (High) / ``crbbNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Level (High) / ``alphaNoiseLevelHigh`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Level (Medium) / ``ylrNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Level (Medium) / ``cbagNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Level (Medium) / ``crbbNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Level (Medium) / ``alphaNoiseLevelMedium`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Level (Low) / ``ylrNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Level (Low) / ``cbagNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Level (Low) / ``crbbNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Level (Low) / ``alphaNoiseLevelLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Level (Very Low) / ``ylrNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Level (Very Low) / ``cbagNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Level (Very Low) / ``crbbNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Level (Very Low) / ``alphaNoiseLevelVeryLow`` | Double | 0 | Adjusts the noise variance of the selected channel for the given noise frequency. May be estimated from image data by pressing the "Analyze Noise" button. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Noise Level Gain / ``noiseLevelGain`` | Double | 1 | Global gain to apply to the noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the channel gain. The default value (1.0) is rather conservative (it does not destroy any kind of signal). Values around 1.1 or 1.2 usually give more pleasing results. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Denoise Amount / ``denoiseAmount`` | Double | 1 | The amount of denoising to apply. 0 means no denoising (which may be useful to sharpen without denoising), between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the per-channel amount se in the 'Channel Tuning' group. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Denoise High Frequencies / ``enableFreqHigh`` | Boolean | On | Check to enable the high frequency noise level thresholds. It is recommended to always leave this checked. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| High Gain / ``gainFreqHigh`` | Double | 1 | Gain to apply to the high frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Denoise Medium Frequencies / ``enableFreqMedium`` | Boolean | On | Check to enable the medium frequency noise level thresholds. Can be disabled if the analysis area contains high frequency texture, or if the the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Medium Gain / ``gainFreqMedium`` | Double | 1 | Gain to apply to the medium frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Denoise Low Frequencies / ``enableFreqLow`` | Boolean | On | Check to enable the low frequency noise level thresholds. Must be disabled if the analysis area contains texture, or if the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Low Gain / ``gainFreqLow`` | Double | 1 | Gain to apply to the low frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Denoise Very Low Frequencies / ``enableFreqVeryLow`` | Boolean | On | Check to enable the very low frequency noise level thresholds. Can be disabled in most cases. Must be disabled if the analysis area contains texture, or if the noise is known to be IID (independent and identically distributed), for example if this is only sensor noise and lossless compression is used, and not grain or compression noise. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Very Low Gain / ``gainFreqVeryLow`` | Double | 1 | Gain to apply to the very low frequency noise level thresholds. 0 means no denoising, 1 means use the estimated thresholds multiplied by the channel Gain and the global Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Adaptive Radius / ``adaptiveRadius`` | Integer | 4 | Radius of the window where the signal level is analyzed at each scale. If zero, the signal level is computed from the whole image, which may excessively blur the edges if the image has many flat color areas. A reasonable value should to be in the range 2-4. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Gain / ``ylrGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Y Amount / ``ylrAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Gain / ``cbagGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cb Amount / ``cbagAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Gain / ``crbbGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Cr Amount / ``crbbAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Gain / ``alphaGain`` | Double | 1 | Gain to apply to the thresholds for this channel. 0 means no denoising, 1 means use the estimated thresholds multiplied by the per-frequency gain and the global Noise Level Gain. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Alpha Amount / ``alphaAmount`` | Double | 1 | The amount of denoising to apply to the specified channel. 0 means no denoising, between 0 and 1 does a soft thresholding of below the thresholds, thus keeping some noise, and 1 applies the threshold strictly and removes everything below the thresholds. This should be used only if you want to keep some noise, for example for noise matching. This value is multiplied by the global Denoise Amount. Remember that the thresholds are multiplied by the per-frequency gain, the channel gain, and the Noise Level Gain first. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Sharpen Amount / ``sharpenAmount`` | Double | 0 | Adjusts the amount of sharpening applied. Be careful that only components that are above the noise levels are enhanced, so the noise level gain parameters are very important for proper sharpening. For example, if 'Noise Level Gain' is set to zero (0), then noise is sharpened as well as signal. If the 'Noise Level Gain' is set to one (1), only signal is sharpened. In order to sharpen without denoising, set the 'Denoise Amount' parameter to zero (0). | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Sharpen Size / ``sharpenSize`` | Double | 10 | Adjusts the size of the sharpening. For very unsharp images it is recommended to use higher values. Default is 10. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Sharpen Y Only / ``sharpenLuminance`` | Boolean | On | Sharpens luminance only (if colormodel is R'G'B', sharpen only RGB). This avoids color artifacts to appear. Colour sharpness in natural images is not critical for the human eye. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| (Un)premult / ``premult`` | Boolean | Off | Divide the image by the alpha channel before processing, and re-multiply it afterwards. Use if the input images are premultiplied. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Invert Mask / ``maskInvert`` | Boolean | Off | When checked, the effect is fully applied where the mask is 0. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Mix / ``mix`` | Double | 1 | Mix factor between the original and the transformed image. | ++--------------------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ diff --git a/Documentation/source/plugins/net.sf.openfx.NoOpPlugin.rst b/Documentation/source/plugins/net.sf.openfx.NoOpPlugin.rst index 6ee0b081d2..296e9e1767 100644 --- a/Documentation/source/plugins/net.sf.openfx.NoOpPlugin.rst +++ b/Documentation/source/plugins/net.sf.openfx.NoOpPlugin.rst @@ -12,6 +12,8 @@ Description Copies the input to the ouput. +This effect does not modify the actual content of the image, but can be used to modify the metadata associated with the clip (premultiplication, field order, format, pixel aspect ratio, frame rate). + This plugin concatenates transforms. Inputs diff --git a/Documentation/source/plugins/net.sf.openfx.Noise.rst b/Documentation/source/plugins/net.sf.openfx.Noise.rst index 3c82c3c327..66052d6445 100644 --- a/Documentation/source/plugins/net.sf.openfx.Noise.rst +++ b/Documentation/source/plugins/net.sf.openfx.Noise.rst @@ -39,6 +39,8 @@ Controls +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.Radial.rst b/Documentation/source/plugins/net.sf.openfx.Radial.rst index 80a26c71ec..d15ede2fdf 100644 --- a/Documentation/source/plugins/net.sf.openfx.Radial.rst +++ b/Documentation/source/plugins/net.sf.openfx.Radial.rst @@ -53,6 +53,8 @@ Controls +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.Rectangle.rst b/Documentation/source/plugins/net.sf.openfx.Rectangle.rst index e640f33eec..42ddbb236a 100644 --- a/Documentation/source/plugins/net.sf.openfx.Rectangle.rst +++ b/Documentation/source/plugins/net.sf.openfx.Rectangle.rst @@ -53,6 +53,8 @@ Controls +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +----------------------------------------+-----------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. | diff --git a/Documentation/source/plugins/net.sf.openfx.Reformat.rst b/Documentation/source/plugins/net.sf.openfx.Reformat.rst index 7aa1b50d09..31bdfa2dd2 100644 --- a/Documentation/source/plugins/net.sf.openfx.Reformat.rst +++ b/Documentation/source/plugins/net.sf.openfx.Reformat.rst @@ -10,7 +10,13 @@ Reformat node Description ----------- -Convert the image to another format or size +Convert the image to another format or size. + +An image transform is computed that goes from the input format, regardless of the region of definition (RoD), to the selected format. The Resize Type parameter adjust the way the transform is computed. + +The output format is set by this effect. + +In order to set the output format without transforming the image content, use the NoOp effect. This plugin concatenates transforms. diff --git a/Documentation/source/plugins/net.sf.openfx.Solid.rst b/Documentation/source/plugins/net.sf.openfx.Solid.rst index 7d37b9868f..13b0db1390 100644 --- a/Documentation/source/plugins/net.sf.openfx.Solid.rst +++ b/Documentation/source/plugins/net.sf.openfx.Solid.rst @@ -37,6 +37,8 @@ Controls +--------------------------------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Center / ``recenter`` | Button |   | Centers the region of definition to the input region of definition. If there is no input, then the region of definition is centered to the project window. | +--------------------------------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ +| Reformat / ``reformat`` | Boolean | Off | Set the output format to the given extent. | ++--------------------------------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Format / ``NatronParamFormatChoice`` | Choice | HD 1920x1080 | The output format | +--------------------------------------------+-----------+------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Bottom Left / ``bottomLeft`` | Double | x: 0 y: 0 | Coordinates of the bottom left corner of the size rectangle. |