.. _net.sf.openfx.CropPlugin:

Crop node
=========

.. raw:: html

   <!-- Do not edit this file! It is generated automatically by Natron itself. -->

|pluginIcon| 

*This documentation is for version 1.0 of Crop (net.sf.openfx.CropPlugin).*

Description
-----------

Removes everything outside the defined rectangle and optionally adds black edges so everything outside is black.

If the ‘Extent’ parameter is set to ‘Format’, and ‘Reformat’ is checked, the output pixel aspect ratio is also set to this of the format.

This plugin does not concatenate transforms.

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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 
| Extent / ``extent``                  | Choice  | Size          | | Extent (size and offset) of the output.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
|                                      |         |               | | **Format (format)**: Use a pre-defined image format.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                      |         |               | | **Size (size)**: Use a specific extent (size and offset).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                      |         |               | | **Project (project)**: Use the project extent (size and offset).                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                      |         |               | | **Default (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                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|                                      |         |               | | **PC_Video 640x480 (PC_Video)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|                                      |         |               | | **NTSC 720x486 0.91 (NTSC)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                      |         |               | | **PAL 720x576 1.09 (PAL)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|                                      |         |               | | **NTSC_16:9 720x486 1.21 (NTSC_16:9)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|                                      |         |               | | **PAL_16:9 720x576 1.46 (PAL_16:9)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
|                                      |         |               | | **HD_720 1280x720 (HD_720)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
|                                      |         |               | | **HD 1920x1080 (HD)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|                                      |         |               | | **UHD_4K 3840x2160 (UHD_4K)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                      |         |               | | **1K_Super_35(full-ap) 1024x778 (1K_Super_35(full-ap))**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
|                                      |         |               | | **1K_Cinemascope 914x778 2.00 (1K_Cinemascope)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
|                                      |         |               | | **2K_Super_35(full-ap) 2048x1556 (2K_Super_35(full-ap))**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                      |         |               | | **2K_Cinemascope 1828x1556 2.00 (2K_Cinemascope)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                      |         |               | | **2K_DCP 2048x1080 (2K_DCP)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                      |         |               | | **4K_Super_35(full-ap) 4096x3112 (4K_Super_35(full-ap))**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|                                      |         |               | | **4K_Cinemascope 3656x3112 2.00 (4K_Cinemascope)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|                                      |         |               | | **4K_DCP 4096x2160 (4K_DCP)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
|                                      |         |               | | **square_256 256x256 (square_256)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                      |         |               | | **square_512 512x512 (square_512)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                      |         |               | | **square_1K 1024x1024 (square_1K)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
|                                      |         |               | | **square_2K 2048x2048 (square_2K)**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
 
| 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.                                                                                                                                                                                                                                                                                                                                                                                                               |
 
| HiDPI / ``hidpi``                    | Boolean | Off           | Should be checked when the display area is High-DPI (a.k.a Retina). Draws OpenGL overlays twice larger.                                                                                                                                                                                                                                                                                                                                                                                                                                      |
 
| 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). 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. |
 
| 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%
