image_transformer package

Subpackages

• image_transformer.image_processors package
  • Submodules
  • image_transformer.image_processors.generic_grid_image_processor module
    • GenericGridImageProcessor
      • GenericGridImageProcessor.approximate_number_of_grid_elements()
      • GenericGridImageProcessor.draw_grid_element_at()
      • GenericGridImageProcessor.from_grid_coordinates_to_center_in_pixel_coordinates()
      • GenericGridImageProcessor.from_pixel_coordinates_to_grid_coordinates()
  • image_transformer.image_processors.hexagonal_grid_image_processor module
    • HexagonalGridImageProcessor
      • HexagonalGridImageProcessor.approximate_number_of_grid_elements()
      • HexagonalGridImageProcessor.draw_grid_element_at()
      • HexagonalGridImageProcessor.from_grid_coordinates_to_center_in_pixel_coordinates()
      • HexagonalGridImageProcessor.from_pixel_coordinates_to_grid_coordinates()
  • image_transformer.image_processors.square_grid_image_processor module
    • SquareGridImageProcessor
      • SquareGridImageProcessor.approximate_number_of_grid_elements()
      • SquareGridImageProcessor.draw_grid_element_at()
      • SquareGridImageProcessor.from_grid_coordinates_to_center_in_pixel_coordinates()
      • SquareGridImageProcessor.from_pixel_coordinates_to_grid_coordinates()
  • image_transformer.image_processors.triangle_grid_image_processor module
    • TriangleGridImageProcessor
      • TriangleGridImageProcessor.approximate_number_of_grid_elements()
      • TriangleGridImageProcessor.draw_grid_element_at()
      • TriangleGridImageProcessor.from_grid_coordinates_to_center_in_pixel_coordinates()
      • TriangleGridImageProcessor.from_pixel_coordinates_to_grid_coordinates()
  • Module contents
• image_transformer.output_builders package
  • Submodules
  • image_transformer.output_builders.cairo_svg_output_builder module
    • CairoSvgOutputBuilder
      • CairoSvgOutputBuilder.add_hexagon()
      • CairoSvgOutputBuilder.add_polygon()
      • CairoSvgOutputBuilder.add_rectangle()
      • CairoSvgOutputBuilder.save()
  • image_transformer.output_builders.generic_output_builder module
    • GenericOutputBuilder
      • GenericOutputBuilder.add_hexagon()
      • GenericOutputBuilder.add_polygon()
      • GenericOutputBuilder.add_rectangle()
      • GenericOutputBuilder.save()
  • image_transformer.output_builders.handmade_svg_output_builder module
    • HandmadeSvgOutputBuilder
      • HandmadeSvgOutputBuilder.add_hexagon()
      • HandmadeSvgOutputBuilder.add_polygon()
      • HandmadeSvgOutputBuilder.add_rectangle()
      • HandmadeSvgOutputBuilder.save()
  • Module contents
• image_transformer.pixels_processors package
  • Submodules
  • image_transformer.pixels_processors.average_pixels_processor module
    • AveragePixelsProcessor
      • AveragePixelsProcessor.get_rgb_color_from_pixels()
  • image_transformer.pixels_processors.generic_pixels_processor module
    • GenericPixelsProcessor
      • GenericPixelsProcessor.get_rgb_color_from_pixels()
  • image_transformer.pixels_processors.most_frequent_pixels_processor module
    • MostFrequentPixelsProcessor
      • MostFrequentPixelsProcessor.get_rgb_color_from_pixels()
  • image_transformer.pixels_processors.random_pixels_processor module
    • RandomPixelsProcessor
      • RandomPixelsProcessor.get_rgb_color_from_pixels()
  • Module contents
• image_transformer.utils package
  • Submodules
  • image_transformer.utils.arguments_parser module
  • image_transformer.utils.arguments_validator module
  • image_transformer.utils.configurations_loader module
    • load_configurations()
  • image_transformer.utils.loader module
    • load_image()
  • Module contents

Submodules

image_transformer.constants module

This module defines constants for various image processors, pixel processors, and output builders used in the project.

image_transformer.image_transformer module

This module provides the ImageTransformer class, which is used to transform images using various processors and save the output.

class image_transformer.image_transformer.ImageTransformer(image_array: ndarray)

Bases: object

A class used to transform images using various processors and save the output.

classmethod from_pil_image(pil_image: <module 'PIL.Image' from '/home/runner/work/image-transformer/image-transformer/.venv/lib/python3.12/site-packages/PIL/Image.py'>) → ImageTransformer

Class method to create an ImageTransformer instance from a PIL image.

Parameters:

pil_image (PIL.Image) – A PIL image object.

Returns:

An instance of ImageTransformer.

Return type:

ImageTransformer

steps: list[str] = ['step-1', 'step-2']

transform_and_save(image_processor: GenericGridImageProcessor, pixels_processor: GenericPixelsProcessor, output_builder: GenericOutputBuilder, callback: Callable[[str, int], None] | None = None) → Any

Transforms the image using the provided processors and saves the output.

Parameters:

• image_processor (GenericGridImageProcessor) – An object responsible for processing the image grid.

• pixels_processor (GenericPixelsProcessor) – An object responsible for processing the pixels.

• output_builder (GenericOutputBuilder) – An object responsible for building the output.

• callback (Optional[Callable[[str, int], None]]) – A callback function to report progress.

Returns

Any: The result of the output builder’s save method.

image_transformer.index module

This module provides the main entry point for the image-transformer program. It parses command-line arguments, loads an image, processes it using specified image and pixel processors, and outputs the result as an SVG file.

image_transformer.index.main()

Main function to execute the image transformation process.

Module contents

This module initializes the image_transformer package by importing all functions and classes from the image_transformer module.