Skip to content

Latest commit

 

History

History
125 lines (74 loc) · 2.22 KB

File metadata and controls

125 lines (74 loc) · 2.22 KB

Io

Layeredimage Index / Layeredimage / Io

Auto-generated documentation for layeredimage.io module.

exportFlatImage

Show source in init.py:114

Export the layered image to a unilayer image file.

Signature

def exportFlatImage(fileName: str, layeredImage: LayeredImage) -> None: ...

See also

extNotRecognised

Show source in init.py:26

Output the file extension not recognised error.

Signature

def extNotRecognised(fileName: str) -> None: ...

openLayerImage

Show source in init.py:35

Open a layer image file into a layer image object.

Arguments


  • file str - path/ filename

Raises


  • FileExistsError - If the layered image does not exist
  • ValueError - If the extention is not recognised

Returns


  • LayeredImage - a layered image object

Signature

def openLayerImage(file: str | Path) -> LayeredImage: ...

See also

saveLayerImage

Show source in init.py:76

Save a layered image to a file.

Arguments


  • fileName str - path/ filename
  • layeredImage LayeredImage - the layered image to save

Raises


  • ValueError - If the extention is not recognised

Returns


None

Signature

def saveLayerImage(fileName: str | Path, layeredImage: LayeredImage) -> None: ...

See also

Modules