Module `generativepy.utils`

Expand source code

# Author:  Martin McBride
# Created: 2020-11-22
# Copyright (C) 2020, Martin McBride
# License: MIT

import sys
import tempfile
import os.path

def correct_pycairo_byte_order(array, channels):
    """
    If byte ordering is little endian, bitmap data from Pycairo needs swapping
    Convert a numpy array from BGR/BGRA ordering to RGB/RGBA.
    Conversion is performed in place

    Args:
        array: numpy array - the image data.
        channels: int - number of colour channels (3 or 4 for RGB or RGBA).

    Returns:
        Converted array (will be original array if no conversion needed).
    """

    if sys.byteorder == 'little' and array.ndim == 3:
        if channels==3:
            array[:, :, [0, 1, 2]] = array[:, :, [2, 1, 0]]
        elif channels==4:
            array[:, :, [0, 1, 2, 3]] = array[:, :, [2, 1, 0, 3]]

    return array

def temp_file(*names):
    """
    Create a temporary file name path within the system temp folder.
    If *name has one element, return <temp>/name[0]
    If *name has two element, return <temp>/name[0]/name[1] etc

    Args:
        *names: one or more file/folder names.

    Returns:
        Full file path as a string.
    """

    folder = tempfile.gettempdir()
    return os.path.join(folder, *names)

Functions

def correct_pycairo_byte_order(array, channels)

If byte ordering is little endian, bitmap data from Pycairo needs swapping Convert a numpy array from BGR/BGRA ordering to RGB/RGBA. Conversion is performed in place

Args

array: numpy array - the image data.
channels: int - number of colour channels (3 or 4 for RGB or RGBA).

Returns

Converted array (will be original array if no conversion needed).

Expand source code

def correct_pycairo_byte_order(array, channels):
    """
    If byte ordering is little endian, bitmap data from Pycairo needs swapping
    Convert a numpy array from BGR/BGRA ordering to RGB/RGBA.
    Conversion is performed in place

    Args:
        array: numpy array - the image data.
        channels: int - number of colour channels (3 or 4 for RGB or RGBA).

    Returns:
        Converted array (will be original array if no conversion needed).
    """

    if sys.byteorder == 'little' and array.ndim == 3:
        if channels==3:
            array[:, :, [0, 1, 2]] = array[:, :, [2, 1, 0]]
        elif channels==4:
            array[:, :, [0, 1, 2, 3]] = array[:, :, [2, 1, 0, 3]]

    return array

def temp_file(*names)

Create a temporary file name path within the system temp folder. If name has one element, return /name[0] If name has two element, return /name[0]/name[1] etc

Args

*names: one or more file/folder names.

Returns

Full file path as a string.

Expand source code

def temp_file(*names):
    """
    Create a temporary file name path within the system temp folder.
    If *name has one element, return <temp>/name[0]
    If *name has two element, return <temp>/name[0]/name[1] etc

    Args:
        *names: one or more file/folder names.

    Returns:
        Full file path as a string.
    """

    folder = tempfile.gettempdir()
    return os.path.join(folder, *names)