ComfyUI Node: XYImage

XYImage:

The XYImage node is designed to facilitate the creation and manipulation of image grids, allowing you to organize and display multiple images in a structured format. This node is particularly useful for visualizing variations across different parameters or conditions, such as different image processing techniques or transformations. By leveraging the xy_image method, the node can handle complex arrangements of images, including the ability to flip images along specified axes, stack them in various modes, and annotate them with labels. This functionality is beneficial for AI artists who need to compare and contrast different image outputs in a cohesive and visually appealing manner, enhancing the ability to analyze and interpret results effectively.

XYImage Input Parameters:

images

This parameter expects a list of image tensors, which are the core data structures representing the images you want to organize into a grid. Each tensor corresponds to an individual image, and the list can contain multiple tensors to form a comprehensive grid. The images are processed and arranged based on the other parameters provided.

splits

The splits parameter is a list of integers that determines how the images are divided or grouped within the grid. Each integer in the list specifies the number of images in a particular section or row of the grid, allowing for flexible and customized grid layouts.

flip_axis

This parameter is a list of strings indicating the axes along which the images should be flipped. Common options include "horizontal" or "vertical," and this feature can be used to create mirrored or rotated versions of the images within the grid, adding variety and depth to the visual presentation.

batch_stack_mode

The batch_stack_mode parameter is a list of strings that defines how image batches are stacked within the grid. This can include options like "horizontal" or "vertical," determining the overall orientation and flow of the image grid, which can impact the visual coherence and accessibility of the displayed images.

z_enabled

This parameter is a list of strings that indicates whether a third dimension, or "z-axis," is enabled for the grid. When set to "True," it allows for the inclusion of additional layers or sets of images, providing a more complex and multi-dimensional grid structure. This is particularly useful for comparing images across multiple conditions or parameters.

x_main_label

An optional list of strings that provides a main label for the x-axis of the grid. This label serves as a title or descriptor for the images arranged along the horizontal axis, helping to contextualize the images and enhance the interpretability of the grid.

y_main_label

Similar to x_main_label, this optional parameter is a list of strings that provides a main label for the y-axis of the grid. It serves as a title or descriptor for the images arranged along the vertical axis, aiding in the understanding and analysis of the grid's content.

z_main_label

An optional list of strings that provides a main label for the z-axis when z_enabled is set to "True." This label helps to identify and describe the additional layers or sets of images included in the grid, facilitating a deeper understanding of the multi-dimensional structure.

x_labels

An optional list of strings that provides individual labels for each section or row along the x-axis. These labels offer specific context or information about the images in each section, enhancing the clarity and detail of the grid presentation.

y_labels

An optional list of strings that provides individual labels for each section or column along the y-axis. These labels help to identify and describe the images in each column, contributing to a more informative and organized grid layout.

z_labels

An optional list of strings that provides individual labels for each layer or set of images along the z-axis when z_enabled is "True." These labels offer additional context and detail for the multi-dimensional grid, aiding in the analysis and interpretation of the images.

XYImage Output Parameters:

List[Tensor]

The output of the XYImage node is a list of image tensors, representing the organized and processed images in the grid format. Each tensor corresponds to a section or layer of the grid, and the list provides a comprehensive view of the entire grid structure. This output is crucial for further analysis, visualization, or processing of the images, allowing you to work with a cohesive and structured set of image data.

XYImage Usage Tips:

• Ensure that the splits parameter accurately reflects the desired grid layout to avoid misalignment or unexpected arrangements of images.
• Utilize the flip_axis and batch_stack_mode parameters to experiment with different orientations and stacking methods, which can enhance the visual appeal and clarity of the grid.
• When using z_enabled, provide comprehensive x_labels, y_labels, and z_labels to fully leverage the multi-dimensional capabilities of the grid and improve interpretability.

XYImage Common Errors and Solutions:

"Must provide x_labels and y_labels when z_enabled is True."

• Explanation: This error occurs when the z_enabled parameter is set to "True," but the necessary x_labels and y_labels are not provided.
• Solution: Ensure that both x_labels and y_labels are specified when enabling the z-axis to provide the required context and structure for the grid.

"Image sizes do not match."

• Explanation: This error can happen if the images provided in the images list have different dimensions, which prevents them from being arranged into a uniform grid.
• Solution: Verify that all images have the same dimensions before passing them to the node, or preprocess them to ensure uniformity.