Référence de la classe aidge_in_space.codecs.base.Codec

Classe de base de tous les codecs. Plus de détails...

Graphe d'héritage de aidge_in_space.codecs.base.Codec:

Fonctions membres publiques
	available (self)
	Indique si le codec peut s'exécuter sur cette machine.
	levels (self, mode)
	Niveaux proposés, du plus bas au plus haut débit.
	run (self, img, level, mode, backend="torch", real_rate=True)
	Compresse puis décompresse une image.
	__repr__ (self)
	Représentation courte : classe et identifiant.

Attributs publics statiques
str	key = ""
	Identifiant unique, utilisé par la ligne de commande et dans les CSV.
str	label = ""
	Nom affiché.
str	family = ""
	"Classique" ou "Appris" ; les codecs classiques sont listés en premier.
str	description = ""
	Description courte affichée dans l'onglet « Codecs et aide ».
tuple	modes = ("gris", "rgb")
	Modes d'image acceptés : "gris" et/ou "rgb".
tuple	backends = ()
	Moteurs d'exécution possibles pour l'encodeur (voir aidge_in_space.backends) ; vide = sans objet.

Description détaillée

Classe de base de tous les codecs.

Pour ajouter un codec, créer un module dans aidge_in_space/codecs/ qui définit une fonction codecs() renvoyant des instances de sous-classes de Codec : il est découvert automatiquement par aidge_in_space.codecs.discover().

Documentation des fonctions membres

available()

aidge_in_space.codecs.base.Codec.available

(

self

)

Indique si le codec peut s'exécuter sur cette machine.

Renvoie

Couple (disponible, raison de l'indisponibilité ou chaîne vide).

Réimplémentée dans aidge_in_space.codecs.classical.PillowCodec.

levels()

aidge_in_space.codecs.base.Codec.levels	(		self,
			mode )

Niveaux proposés, du plus bas au plus haut débit.

Paramètres

mode	"gris" ou "rgb".

Renvoie

Liste de Level.

Réimplémentée dans aidge_in_space.codecs.balle2017.Balle2017Codec, aidge_in_space.codecs.bmshj2018.Pretrained2018, aidge_in_space.codecs.classical.Jpeg, aidge_in_space.codecs.classical.Jpeg2000, et aidge_in_space.codecs.classical.WebP.

run()

aidge_in_space.codecs.base.Codec.run	(		self,
			img,
			level,
			mode,
			backend = "torch",
			real_rate = True )

Compresse puis décompresse une image.

Paramètres

img	Image uint8, H x W (gris) ou H x W x 3 (rgb).
level	Level choisi parmi levels(mode).
mode	"gris" ou "rgb".
backend	Moteur de l'encodeur (codecs appris uniquement), clé de aidge_in_space.backends.BACKENDS.
real_rate	True : flux réellement produit ; False : débit estimé si le codec le permet.

Renvoie

Result dont l'image reconstruite a la même forme que img.

Réimplémentée dans aidge_in_space.codecs.base.LearnedCodec, et aidge_in_space.codecs.classical.PillowCodec.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• base.py