Skip to content

result_handle

result_handle

Module contains handle class to drawing instructions visualization.

Rasterized2DResultHandle

Bases: ResultHandle

Handle to drawing instructions visualization.

Source code in src/pygerber/backend/rasterized_2d/result_handle.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class Rasterized2DResultHandle(ResultHandle):
    """Handle to drawing instructions visualization."""

    def __init__(self, result: Image.Image) -> None:
        """Initialize result handle.

        Parameters
        ----------
        result : Image.Image
            Image object containing finished Gerber image.
        """
        super().__init__()
        self.result = result

    def save(
        self,
        dest: Path | str | BytesIO,
        **kwargs: Any,
    ) -> None:
        """Save result to destination.

        Parameters
        ----------
        dest : Path | str | BytesIO
            Write target.
        **kwargs: Any
            Extra parameters which will be passed to `Image.save()`.
            For details see [Pillow documentation](https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.Image.save).
        """
        self.get_image().save(dest, **kwargs)

    def get_image(self) -> Image.Image:
        """Get result image object."""
        return self.result.transpose(Image.FLIP_TOP_BOTTOM)

__init__ 

__init__(result: Image.Image) -> None

Initialize result handle.

Parameters:

Name Type Description Default
result Image.Image

Image object containing finished Gerber image.

 required
Source code in src/pygerber/backend/rasterized_2d/result_handle.py 
18
19
20
21
22
23
24
25
26
27
def __init__(self, result: Image.Image) -> None:
    """Initialize result handle.

    Parameters
    ----------
    result : Image.Image
        Image object containing finished Gerber image.
    """
    super().__init__()
    self.result = result

save 

save(dest: Path | str | BytesIO, **kwargs: Any) -> None

Save result to destination.

Parameters:

Name Type Description Default
dest Path | str | BytesIO

Write target.

 required
**kwargs Any

Extra parameters which will be passed to Image.save(). For details see Pillow documentation.

 {}
Source code in src/pygerber/backend/rasterized_2d/result_handle.py 
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def save(
    self,
    dest: Path | str | BytesIO,
    **kwargs: Any,
) -> None:
    """Save result to destination.

    Parameters
    ----------
    dest : Path | str | BytesIO
        Write target.
    **kwargs: Any
        Extra parameters which will be passed to `Image.save()`.
        For details see [Pillow documentation](https://pillow.readthedocs.io/en/stable/reference/Image.html#PIL.Image.Image.save).
    """
    self.get_image().save(dest, **kwargs)

get_image 

get_image() -> Image.Image

Get result image object.

Source code in src/pygerber/backend/rasterized_2d/result_handle.py 
46
47
48
def get_image(self) -> Image.Image:
    """Get result image object."""
    return self.result.transpose(Image.FLIP_TOP_BOTTOM)