Skip to main content

Image Crop By Mask Batch

KJNodes/image
ImageCropByMaskBatch

Crops the input images based on the provided masks.

Example

JSON Example
{
  "class_type": "ImageCropByMaskBatch",
  "inputs": {
    "image": [
      "node_id",
      0
    ],
    "masks": [
      "node_id",
      0
    ],
    "width": 512,
    "height": 512,
    "padding": 0,
    "preserve_size": false,
    "bg_color": "0, 0, 0"
  }
}

This example shows required inputs only. Connection values like ["node_id", 0] should reference actual node IDs from your workflow.

Inputs

NameTypeStatusConstraintsDefault
imageIMAGErequired--
masksMASKrequired--
widthINTrequiredmin: 0, max: 16384, step: 8512
heightINTrequiredmin: 0, max: 16384, step: 8512
paddingINTrequiredmin: 0, max: 4096, step: 10
preserve_sizeBOOLEANrequired-false
bg_color?STRINGrequired-"0, 0, 0"

Outputs

IndexNameTypeIs ListConnection Reference
0imagesIMAGENo["{node_id}", 0]
1masksMASKNo["{node_id}", 1]
How to connect to these outputs

To connect another node's input to an output from this node, use the connection reference format:

["node_id", output_index]

Where node_id is the ID of this ImageCropByMaskBatch node in your workflow, and output_index is the index from the table above.

Example

If this node has ID "5" in your workflow:

  • images (IMAGE): ["5", 0]
  • masks (MASK): ["5", 1]
Was this page helpful?