Package: layeredimage
LayeredImageUse this module to read, and write to a number of layered image formatsCompatibilityOverviewKeyReading - GroupReading - LayerWriting - GroupWriting - Layer.layeredExample UsageDocumentationInstall With PIPLanguage informationBuilt forInstall Python on WindowsChocolateyWindows - Python.orgInstall Python on LinuxAptDnfInstall Python on MacOSHomebrewMacOS - Python.orgHow to runWindowsLinux/ MacOSBuildingTestingDownload ProjectCloneUsing The Command LineUsing GitHub DesktopDownload Zip FileCommunity FilesLicenceChangelogCode of ConductContributingSecuritySupportRationaleCompatibilityBear in mind that the tables below may not be completely accurate. If that is
the case, please open an issue and I will fix the tables.OverviewKey✔ - Supported⚠ - Things will look the same, but data is lost❌ - This is not supported and will cause loss of dataN/A - The source format does not support this so treat this as a ✔Format.ora.pdn.xcf.psd.tiff/ .tif.webp.gif.lsrRead✔✔✔✔✔✔✔✔Layers✔✔✔✔✔✔✔✔Groups✔N/A✔✔N/AN/AN/A✔Write✔❌❌❌⚠⚠⚠✔Reading - GroupFormat.ora.pdn.xcf.psd.tiff/ .tif.webp.gif.lsrName✔N/A✔✔N/AN/AN/A✔Dimensions⚠N/A✔✔N/AN/AN/A✔Offsets✔N/A✔✔N/AN/AN/A✔Opacity✔N/A✔✔N/AN/AN/AN/AVisibility✔N/A✔✔N/AN/AN/AN/ABlend Mode✔N/A✔✔N/AN/AN/AN/AReading - LayerFormat.ora.pdn.xcf.psd.tiff/ .tif.webp.gif.lsrName✔✔✔✔✔⚠⚠✔Dimensions✔✔✔✔✔✔✔✔Offsets✔N/A✔✔✔N/AN/AN/AOpacity✔✔✔✔N/AN/AN/AN/AVisibility✔✔✔✔N/AN/AN/AN/ABlend Mode✔✔✔✔N/AN/AN/AN/AWriting - GroupFormat.ora.pdn.xcf.psd.tiff/ .tif.webp.gif.lsrName✔❌❌❌❌❌❌✔Dimensions✔❌❌❌⚠⚠⚠✔Offsets✔❌❌❌⚠⚠⚠✔Opacity✔❌❌❌⚠⚠⚠⚠Visibility✔❌❌❌⚠⚠⚠⚠Blend Mode✔❌❌❌❌❌❌❌Layers are extracted from groups and saved to TIFF/ GIF or WEBPWriting - LayerFormat.ora.pdn.xcf.psd.tiff/ .tif.webp.gif.lsrName✔❌❌❌❌❌❌⚠Dimensions✔❌❌❌⚠⚠⚠⚠Offsets✔❌❌❌⚠⚠⚠⚠Opacity✔❌❌❌⚠⚠⚠⚠Visibility✔❌❌❌⚠⚠⚠⚠Blend Mode✔❌❌❌❌❌❌❌Layers are rendered with offsets before being written to TIFF/ GIF or WEBP
First child layers are placed in a group when written to LSR.layered.layered is highly inspired by the open raster format and aims to provide an
exchange format in the cases when saving in ora would cause unacceptable data
loss. .layered has been designed so that if the format became deprecated and no
readers existed for it tomorrow, the data would be easily salvageable.See theLAYERED_SPECfor more information.Example UsageHere's some basic example usage below."""Example module """frompathlibimportPathTHISDIR=str(Path(__file__).resolve().parent)importlayeredimage.io# Do stuffora=layeredimage.io.openLayerImage(f"{THISDIR}/image.ora")imageDimensions=ora.dimensions# There are a load of handy functions for getting layers, and adding new# layers, but here we will act directly on the objectlayer=ora.layersAndGroups[0]# For the sake of the e.g. this is a layer# Lets overwrite the layer with a transparent image (bit boring I know...)layer.image=Image.new("RGBA",imageDimensions)ora.layersAndGroups[0]=layer# And let's savelayeredimage.io.saveLayerImage(f"{THISDIR}/image(modified).ora",ora)# Let's save a flattened version tooora.getFlattenLayers().save(f"{THISDIR}/image(modified).png")# Doing stuff with a groupgroup=ora.getLayerOrGroup(1)# For the sake of the e.g. this is a groupgroup.layers[0].image.show()# Open the image of the first layer of the group# Deleting a layer/ groupora.removeLayerOrGroup(2)Images are PIL.Image (s) and so you can use the power of Pillow to apply
filters, and other modifications to the images.See below for an old version of the tests. These provide a few examples of
file conversions. Not going to get 100% coverage anytime soon but hopefully
this will help a little."""Test module """importsysimportosfrompathlibimportPathTHISDIR=str(Path(__file__).resolve().parent)sys.path.insert(0,os.path.dirname(THISDIR))importlayeredimage.io# ORAora=layeredimage.io.openLayerImage(f"{THISDIR}/base24.ora")layeredimage.io.saveLayerImage(f"{THISDIR}/base24(ora).ora",ora)layeredimage.io.saveLayerImage(f"{THISDIR}/base24(ora).tiff",ora)ora.getFlattenLayers().save(f"{THISDIR}/base24(ora).png")# PSDpsd=layeredimage.io.openLayerImage(f"{THISDIR}/base24.psd")layeredimage.io.saveLayerImage(f"{THISDIR}/base24(psd).ora",psd)layeredimage.io.saveLayerImage(f"{THISDIR}/base24(psd).tiff",psd)psd.getFlattenLayers().save(f"{THISDIR}/base24(psd).png")# PDNpdn=layeredimage.io.openLayerImage(f"{THISDIR}/base24.pdn")layeredimage.io.saveLayerImage(f"{THISDIR}/base24(pdn).ora",pdn)layeredimage.io.saveLayerImage(f"{THISDIR}/base24(pdn).tiff",pdn)pdn.getFlattenLayers().save(f"{THISDIR}/base24(pdn).png")# XCFxcf=layeredimage.io.openLayerImage(f"{THISDIR}/base24.xcf")layeredimage.io.saveLayerImage(f"{THISDIR}/base24(xcf).ora",xcf)layeredimage.io.saveLayerImage(f"{THISDIR}/base24(xcf).tiff",xcf)xcf.getFlattenLayers().save(f"{THISDIR}/base24(xcf).png")# TIFFtiff=layeredimage.io.openLayerImage(f"{THISDIR}/base24.tiff")layeredimage.io.saveLayerImage(f"{THISDIR}/base24(tiff).ora",tiff)layeredimage.io.saveLayerImage(f"{THISDIR}/base24(tiff).tiff",tiff)tiff.getFlattenLayers().save(f"{THISDIR}/base24(tiff).png")DocumentationA high-level overview of how the documentation is organized organized will help you know
where to look for certain things:TheTechnical Referencedocuments APIs and other aspects of the
machinery. This documentation describes how to use the classes and functions at a lower level
and assume that you have a good high-level understanding of the software.Install With PIPpipinstalllayeredimageHead tohttps://pypi.org/project/layeredimage/for more infoLanguage informationBuilt forThis program has been written for Python versions 3.8 - 3.11 and has been tested with both 3.8 and
3.11Install Python on WindowsChocolateychocoinstallpythonWindows - Python.orgTo install Python, go tohttps://www.python.org/downloads/windows/and download the latest
version.Install Python on LinuxAptsudoaptinstallpython3.xDnfsudodnfinstallpython3.xInstall Python on MacOSHomebrewbrewinstallpython@3.xMacOS - Python.orgTo install Python, go tohttps://www.python.org/downloads/macos/and download the latest
version.How to runWindowsModulepy -3.x -m [module]or[module](if module installs a script)Filepy -3.x [file]or./[file]Linux/ MacOSModulepython3.x -m [module]or[module](if module installs a script)Filepython3.x [file]or./[file]BuildingThis project useshttps://github.com/FHPythonUtils/FHMaketo automate most of the building. This
command generates the documentation, updates the requirements.txt and builds the library artefactsNote the functionality provided by fhmake can be approximated by the followinghandsdown--cleanup-odocumentation/reference
poetryexport-frequirements.txt--outputrequirements.txt
poetryexport-frequirements.txt--withdev--outputrequirements_optional.txt
poetrybuildfhmake auditcan be run to perform additional checksTestingFor testing with the version of python used by poetry usepoetryrunpytestAlternatively usetoxto run tests over python 3.8 - 3.11toxDownload ProjectCloneUsing The Command LinePress the Clone or download button in the top rightCopy the URL (link)Open the command line and change directory to where you wish to
clone toType 'git clone' followed by URL in step 2gitclonehttps://github.com/FHPythonUtils/LayeredImageMore information can be found athttps://help.github.com/en/articles/cloning-a-repositoryUsing GitHub DesktopPress the Clone or download button in the top rightClick open in desktopChoose the path for where you want and click CloneMore information can be found athttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktopDownload Zip FileDownload this GitHub repositoryExtract the zip archiveCopy/ move to the desired locationCommunity FilesLicenceMIT License
Copyright (c) FredHappyface
(See theLICENSEfor more information.)ChangelogSee theChangelogfor more information.Code of ConductOnline communities include people from many backgrounds. TheProjectcontributors are committed to providing a friendly, safe and welcoming
environment for all. Please see theCode of Conductfor more information.ContributingContributions are welcome, please see theContributing Guidelinesfor more information.SecurityThank you for improving the security of the project, please see theSecurity Policyfor more information.SupportThank you for using this project, I hope it is of use to you. Please be aware that
those involved with the project often do so for fun along with other commitments
(such as work, family, etc). Please see theSupport Policyfor more information.RationaleThe rationale acts as a guide to various processes regarding projects such as
the versioning scheme and the programming styles used. Please see theRationalefor more information.