pe.logger.image_file module
- class pe.logger.image_file.ImageFile(output_folder, path_separator='-', iteration_format='09d')[source]
Bases:
Logger
The logger that saves images to files.
- __init__(output_folder, path_separator='-', iteration_format='09d')[source]
Constructor.
- Parameters:
output_folder (str) – The output folder that will be used to save the images
path_separator (str, optional) – The string that will be used to replace ‘’ and ‘/’ in log names, defaults to “-”
iteration_format (str, optional) – The format of the iteration number, defaults to “09d”
- _get_image_path(iteration, item)[source]
Get the image save path.
- Parameters:
iteration (int) – The PE iteration number
item (
pe.metric_item.ImageMetricItem
orpe.metric_item.ImageListMetricItem
) – The image metric item
- Returns:
The image save path
- Return type:
str
- _log_image(image_path, item)[source]
Log a single image.
- Parameters:
image_path (str) – The path to save the image
item (
pe.metric_item.ImageMetricItem
) – The image metric item
- _log_image_list(image_path, item)[source]
Log a list of images.
- Parameters:
image_path (str) – The path to save the image
item (
pe.metric_item.ImageListMetricItem
) – The image list metric item
- log(iteration, metric_items)[source]
Log the images.
- Parameters:
iteration (int) – The PE iteration number
metric_items (list[
pe.metric_item.ImageMetricItem
orpe.metric_item.ImageListMetricItem
]) – The images to log