> For the complete documentation index, see [llms.txt](https://docs.tensorleap.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tensorleap.ai/tensorleap-integration/python-api/code_loader/visualizer_classes/leapimage.md).

# LeapImage

code\_loader.contract.visualizer\_classes.LeapImage

Used to visualize a grayscale or RGB image.

```python
@dataclass
class LeapImage:
    data: Union[npt.NDArray[np.float32], npt.NDArray[np.uint8]]
    type: LeapDataType = LeapDataType.Image
    compress: Optional[bool] = True
```

| Args       |                                                                                                                                                                                                                                |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `data`     | `np.ndarray` of dtype `uint8` or `float32`, shape `[H, W, 1]` or `[H, W, 3]`. Pixel values must be in `[0, 255]` for both dtypes: float values are cast to integers, not scaled, so a `[0, 1]` float image shows almost black. |
| `compress` | *(bool, optional)* Images are stored as JPEG by default. Set `compress=False` to store a lossless PNG. Defaults to `True`.                                                                                                     |

## Examples

#### Basic Usage

```python
import cv2
import numpy as np
from code_loader.contract.visualizer_classes import LeapImage
from code_loader.contract.enums import LeapDataType
from code_loader.inner_leap_binder.leapbinder_decorators import tensorleap_custom_visualizer


@tensorleap_custom_visualizer(name='bgr2rgb_vis', visualizer_type=LeapDataType.Image)
def bgr2rgb_visualizer(data: np.ndarray) -> LeapImage:
    image = data[0]                                         # remove the batch axis
    image = (image * 255).clip(0, 255).astype(np.uint8)     # model input was normalized to [0, 1]
    return LeapImage(cv2.cvtColor(image, cv2.COLOR_BGR2RGB))
```

To resize the image and keep the heatmap aligned, see [Resize Image and Heatmap](https://docs.tensorleap.ai/tensorleap-integration/python-api/code_loader/decorators/tensorleap_custom_visualizer.md#resize-image-and-heatmap).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.tensorleap.ai/tensorleap-integration/python-api/code_loader/visualizer_classes/leapimage.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
