Paramètres (`cdl.param`)#

Le module cdl.param fournit tous les paramètres de jeu de données utilisés par les modules cdl.computation et cdl.core.gui.processor.

Ces jeux de données sont définis dans d’autres modules :

cdl.computation.base

cdl.computation.image

cdl.computation.signal

Le module cdl.param est donc un moyen pratique d’importer tous les ensembles de paramètres en une seule fois.

En fait, l’instruction d’importation suivante est équivalente à la précédente :

# Original import statement
from cdl.computation.base import MovingAverageParam
from cdl.computation.signal import PolynomialFitParam
from cdl.computation.image.exposure import EqualizeHistParam

# Equivalent import statement
from cdl.param import MovingAverageParam, PolynomialFitParam, EqualizeHistParam

Introduction aux jeux de données DataSet#

Les jeux de données listés dans les sections suivantes sont utilisés pour définir les paramètres nécessaires aux diverses opérations de calcul et de traitement disponibles dans DataLab.

Ces jeux de données (sous-classes de guidata.dataset.datatypes.Dataset) sont définis dans d’autres modules :

Voici un exemple complet de la façon d’instancier un jeu de données et d’accéder à ses paramètres avec le jeu de données cdl.param.BinningParam :

class cdl.param.BinningParam[source]
Paramètres de binning

sx

Nombre de pixels (X). Nombre de pixels adjacents à regrouper le long de l’axe des x. Entier supérieur à 2. Par défaut : 2.

Type:

guidata.dataset.dataitems.IntItem

sy

Nombre de pixels (Y). Nombre de pixels adjacents à regrouper le long de l’axe des y. Entier supérieur à 2. Par défaut : 2.

Type:

guidata.dataset.dataitems.IntItem

operation

Opération. Sélection unique parmi : “sum”, “average”, “median”, “min”, “max”. Par défaut : “sum”.

Type:

guidata.dataset.dataitems.ChoiceItem

dtype_str

Type de données. Type de données de l’image générée. Sélection unique parmi : “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.

Type:

guidata.dataset.dataitems.ChoiceItem

change_pixel_size

Modification de la taille des pixels de sorte que les dimensions de l’images restent les mêmes après l’opération. Par défaut : False.

Type:

guidata.dataset.dataitems.BoolItem

classmethod create(sx: int, sy: int, operation: str, dtype_str: str, change_pixel_size: bool) → cdl.computation.image.BinningParam

Renvoie une nouvelle instance de BinningParam avec les champs initialisés aux valeurs données.

Paramètres:

sx (int) – Nombre de pixels (X). Nombre de pixels adjacents à regrouper le long de l’axe des x. Entier supérieur à 2. Par défaut : 2.

sy (int) – Nombre de pixels (Y). Nombre de pixels adjacents à regrouper le long de l’axe des y. Entier supérieur à 2. Par défaut : 2.

operation (str) – Opération. Sélection unique parmi : “sum”, “average”, “median”, “min”, “max”. Par défaut : “sum”.

dtype_str (str) – Type de données. Type de données de l’image générée. Sélection unique parmi : “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.

change_pixel_size (bool) – Modification de la taille des pixels de sorte que les dimensions de l’images restent les mêmes après l’opération. Par défaut : False.

Renvoie:

Nouvelle instance de BinningParam.
Note

Pour instancier un nouveau jeu de données BinningParam, vous pouvez utiliser la méthode de classe BinningParam.create() comme ceci :
BinningParam.create(sx=2, sy=2, operation='sum', dtype_str='dtype', change_pixel_size=False)
Vous pouvez également instancier un BinningParam par défaut puis initialiser les champs comme ceci :
param = BinningParam()
param.sx = 2
param.sy = 2
param.operation = 'sum'
param.dtype_str = 'dtype'
param.change_pixel_size = False

Paramètres communs#

class cdl.param.ArithmeticParam[source]

Paramètres arithmétiques

operator

Opérateur. Sélection unique parmi : “+”, “-”, “×”, “/”. Par défaut : “+”.

Type:: guidata.dataset.dataitems.ChoiceItem

factor

Facteur. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

constant

Constante. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

operation

Opération. Par défaut : “”.

Type:: guidata.dataset.dataitems.StringItem

restore_dtype

Résultat. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(operator: str, factor: float, constant: float, operation: str, restore_dtype: bool) → cdl.computation.base.ArithmeticParam

Renvoie une nouvelle instance de ArithmeticParam avec les champs initialisés aux valeurs données.

Paramètres:

operator (str) – Opérateur. Sélection unique parmi : “+”, “-”, “×”, “/”. Par défaut : “+”.
factor (float) – Facteur. Par défaut : 1.0.
constant (float) – Constante. Par défaut : 0.0.
operation (str) – Opération. Par défaut : “”.
restore_dtype (bool) – Résultat. Par défaut : True.

Renvoie:

Nouvelle instance de ArithmeticParam.

get_operation() → str[source]: Return the operation string

update_operation(_item, _value)[source]: Update the operation item

class cdl.param.ClipParam[source]

Paramètres d’écrêtage

lower

Borne inférieure d’écrêtage. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

upper

Borne supérieure d’écrêtage. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(lower: float, upper: float) → cdl.computation.base.ClipParam

Renvoie une nouvelle instance de ClipParam avec les champs initialisés aux valeurs données.

Paramètres:

lower (float) – Borne inférieure d’écrêtage. Par défaut : None.
upper (float) – Borne supérieure d’écrêtage. Par défaut : None.

Renvoie:

Nouvelle instance de ClipParam.

class cdl.param.ConstantParam[source]

Parameter used to set a constant value to used in operations

value

Constante. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(value: float) → cdl.computation.base.ConstantParam

Renvoie une nouvelle instance de ConstantParam avec les champs initialisés aux valeurs données.

Paramètres:: value (float) – Constante. Par défaut : None.
Renvoie:: Nouvelle instance de ConstantParam.

class cdl.param.FFTParam[source]

Paramètres FFT

shift

Décaler la fréquence nulle au centre. Par défaut : None.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(shift: bool) → cdl.computation.base.FFTParam

Renvoie une nouvelle instance de FFTParam avec les champs initialisés aux valeurs données.

Paramètres:: shift (bool) – Décaler la fréquence nulle au centre. Par défaut : None.
Renvoie:: Nouvelle instance de FFTParam.

class cdl.param.GaussianParam[source]

Paramètres de filtre gaussien

sigma

σ. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(sigma: float) → cdl.computation.base.GaussianParam

Renvoie une nouvelle instance de GaussianParam avec les champs initialisés aux valeurs données.

Paramètres:: sigma (float) – σ. Par défaut : 1.0.
Renvoie:: Nouvelle instance de GaussianParam.

class cdl.param.HistogramParam[source]

Histogram parameters

bins

Nombre de classes. Entier supérieur à 1. Par défaut : 256.

Type:: guidata.dataset.dataitems.IntItem

lower

Limite inférieure. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

upper

Limite supérieure. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(bins: int, lower: float, upper: float) → cdl.computation.base.HistogramParam

Renvoie une nouvelle instance de HistogramParam avec les champs initialisés aux valeurs données.

Paramètres:

bins (int) – Nombre de classes. Entier supérieur à 1. Par défaut : 256.
lower (float) – Limite inférieure. Par défaut : None.
upper (float) – Limite supérieure. Par défaut : None.

Renvoie:

Nouvelle instance de HistogramParam.

get_suffix(data: ndarray) → str[source]

Return suffix for the histogram computation

Paramètres:: data – data array

class cdl.param.MovingAverageParam[source]

Paramètres de moyenne mobile

n

Taille de la fenêtre glissante. Entier supérieur à 1. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

mode

Mode du filtre : - “reflect” : réfléchir les données à la frontière - “constant” : remplir avec une valeur constante - “nearest” : remplir avec la valeur la plus proche - “mirror” : réfléchir les données à la frontière avec les données elles-mêmes - “wrap” : frontière circulaire. Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “reflect”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(n: int, mode: str) → cdl.computation.base.MovingAverageParam

Renvoie une nouvelle instance de MovingAverageParam avec les champs initialisés aux valeurs données.

Paramètres:

n (int) – Taille de la fenêtre glissante. Entier supérieur à 1. Par défaut : 3.
mode (str) – Mode du filtre : - “reflect” : réfléchir les données à la frontière - “constant” : remplir avec une valeur constante - “nearest” : remplir avec la valeur la plus proche - “mirror” : réfléchir les données à la frontière avec les données elles-mêmes - “wrap” : frontière circulaire. Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “reflect”.

Renvoie:

Nouvelle instance de MovingAverageParam.

class cdl.param.MovingMedianParam[source]

Paramètres de médiane mobile

n

Taille de la fenêtre glissante. Entier supérieur à 1, impair. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

mode

Mode du filtre : - “reflect” : réfléchir les données à la frontière - “constant” : remplir avec une valeur constante - “nearest” : remplir avec la valeur la plus proche - “mirror” : réfléchir les données à la frontière avec les données elles-mêmes - “wrap” : frontière circulaire. Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “nearest”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(n: int, mode: str) → cdl.computation.base.MovingMedianParam

Renvoie une nouvelle instance de MovingMedianParam avec les champs initialisés aux valeurs données.

Paramètres:

n (int) – Taille de la fenêtre glissante. Entier supérieur à 1, impair. Par défaut : 3.
mode (str) – Mode du filtre : - “reflect” : réfléchir les données à la frontière - “constant” : remplir avec une valeur constante - “nearest” : remplir avec la valeur la plus proche - “mirror” : réfléchir les données à la frontière avec les données elles-mêmes - “wrap” : frontière circulaire. Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “nearest”.

Renvoie:

Nouvelle instance de MovingMedianParam.

class cdl.param.NormalizeParam[source]

Paramètres de normalisation

method

Normaliser par rapport à. Sélection unique parmi : “maximum”, “amplitude”, “area”, “energy”, “rms”. Par défaut : “maximum”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(method: str) → cdl.computation.base.NormalizeParam

Renvoie une nouvelle instance de NormalizeParam avec les champs initialisés aux valeurs données.

Paramètres:: method (str) – Normaliser par rapport à. Sélection unique parmi : “maximum”, “amplitude”, “area”, “energy”, “rms”. Par défaut : “maximum”.
Renvoie:: Nouvelle instance de NormalizeParam.

class cdl.param.SpectrumParam[source]

Paramètres de spectre

log

Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(log: bool) → cdl.computation.base.SpectrumParam

Renvoie une nouvelle instance de SpectrumParam avec les champs initialisés aux valeurs données.

Paramètres:: log (bool) – Par défaut : False.
Renvoie:: Nouvelle instance de SpectrumParam.

Paramètres des signaux#

class cdl.param.AllanVarianceParam[source]

Paramètres de variance d’Allan

max_tau

Max τ. Entier supérieur à 1, unité : pts. Par défaut : 100.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(max_tau: int) → cdl.computation.signal.AllanVarianceParam

Renvoie une nouvelle instance de AllanVarianceParam avec les champs initialisés aux valeurs données.

Paramètres:: max_tau (int) – Max τ. Entier supérieur à 1, unité : pts. Par défaut : 100.
Renvoie:: Nouvelle instance de AllanVarianceParam.

class cdl.param.AngleUnitParam[source]

Choice of angle unit.

unit

Unité de l’angle. Sélection unique parmi : “rad”, “deg”. Par défaut : “rad”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(unit: str) → cdl.computation.signal.AngleUnitParam

Renvoie une nouvelle instance de AngleUnitParam avec les champs initialisés aux valeurs données.

Paramètres:: unit (str) – Unité de l’angle. Sélection unique parmi : “rad”, “deg”. Par défaut : “rad”.
Renvoie:: Nouvelle instance de AngleUnitParam.

class cdl.param.BandPassFilterParam[source]

Paramètres de filtre passe-bande

method

Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.

Type:: guidata.dataset.dataitems.ChoiceItem

order

Ordre du filtre. Entier supérieur à 1. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

f_cut0

Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

f_cut1

Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

rp

Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

rs

Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, order: int, f_cut0: float, f_cut1: float, rp: float, rs: float) → cdl.computation.signal.BandPassFilterParam

Renvoie une nouvelle instance de BandPassFilterParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.
order (int) – Ordre du filtre. Entier supérieur à 1. Par défaut : 3.
f_cut0 (float) – Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
f_cut1 (float) – Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
rp (float) – Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.
rs (float) – Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Renvoie:

Nouvelle instance de BandPassFilterParam.

class cdl.param.BandStopFilterParam[source]

Paramètres de filtre coupe-bande

method

Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.

Type:: guidata.dataset.dataitems.ChoiceItem

order

Ordre du filtre. Entier supérieur à 1. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

f_cut0

Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

f_cut1

Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

rp

Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

rs

Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, order: int, f_cut0: float, f_cut1: float, rp: float, rs: float) → cdl.computation.signal.BandStopFilterParam

Renvoie une nouvelle instance de BandStopFilterParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.
order (int) – Ordre du filtre. Entier supérieur à 1. Par défaut : 3.
f_cut0 (float) – Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
f_cut1 (float) – Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
rp (float) – Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.
rs (float) – Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Renvoie:

Nouvelle instance de BandStopFilterParam.

class cdl.param.DataTypeSParam[source]

Convertir les paramètres de type de données du signal

dtype_str

Type de données de destination. Type de données de l’image générée. Sélection unique parmi : “float32”, “float64”, “complex128”. Par défaut : “float32”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(dtype_str: str) → cdl.computation.signal.DataTypeSParam

Renvoie une nouvelle instance de DataTypeSParam avec les champs initialisés aux valeurs données.

Paramètres:: dtype_str (str) – Type de données de destination. Type de données de l’image générée. Sélection unique parmi : “float32”, “float64”, “complex128”. Par défaut : “float32”.
Renvoie:: Nouvelle instance de DataTypeSParam.

class cdl.param.DetrendingParam[source]

Elimination de tendance

method

Méthode d’élimation de la tendance. Sélection unique parmi : “linear”, “constant”. Par défaut : “linear”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(method: str) → cdl.computation.signal.DetrendingParam

Renvoie une nouvelle instance de DetrendingParam avec les champs initialisés aux valeurs données.

Paramètres:: method (str) – Méthode d’élimation de la tendance. Sélection unique parmi : “linear”, “constant”. Par défaut : “linear”.
Renvoie:: Nouvelle instance de DetrendingParam.

class cdl.param.DynamicParam[source]

Parameters for dynamic range computation (ENOB, SNR, SINAD, THD, SFDR)

full_scale

Pleine échelle. Flottant supérieur à 0.0, unité : v. Par défaut : 0.16.

Type:: guidata.dataset.dataitems.FloatItem

unit

Unité. Unité pour sinad. Sélection unique parmi : “dBc”, “dBFS”. Par défaut : “dBc”.

Type:: guidata.dataset.dataitems.ChoiceItem

nb_harm

Nombre d’harmoniques. Nombre d’harmoniques à considérer pour le thd. Entier supérieur à 1. Par défaut : 5.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(full_scale: float, unit: str, nb_harm: int) → cdl.computation.signal.DynamicParam

Renvoie une nouvelle instance de DynamicParam avec les champs initialisés aux valeurs données.

Paramètres:

full_scale (float) – Pleine échelle. Flottant supérieur à 0.0, unité : v. Par défaut : 0.16.
unit (str) – Unité. Unité pour sinad. Sélection unique parmi : “dBc”, “dBFS”. Par défaut : “dBc”.
nb_harm (int) – Nombre d’harmoniques. Nombre d’harmoniques à considérer pour le thd. Entier supérieur à 1. Par défaut : 5.

Renvoie:

Nouvelle instance de DynamicParam.

class cdl.param.FindAbscissaParam[source]

Parameter dataset for abscissa finding

y

Coordonnées. Par défaut : 0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(y: float) → cdl.computation.signal.FindAbscissaParam

Renvoie une nouvelle instance de FindAbscissaParam avec les champs initialisés aux valeurs données.

Paramètres:: y (float) – Coordonnées. Par défaut : 0.
Renvoie:: Nouvelle instance de FindAbscissaParam.

class cdl.param.FWHMParam[source]

Paramètres de LMH

method

Méthode. Sélection unique parmi : “zero-crossing”, “gauss”, “lorentz”, “voigt”. Par défaut : “zero-crossing”.

Type:: guidata.dataset.dataitems.ChoiceItem

xmin

X_MIN. Borne x inférieure (vide pour aucune limite, c’est-à-dire le début du signal). Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

xmax

X_MAX. Borne x supérieure (vide pour aucune limite, c’est-à-dire la fin du signal). Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, xmin: float, xmax: float) → cdl.computation.signal.FWHMParam

Renvoie une nouvelle instance de FWHMParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode. Sélection unique parmi : “zero-crossing”, “gauss”, “lorentz”, “voigt”. Par défaut : “zero-crossing”.
xmin (float) – X_MIN. Borne x inférieure (vide pour aucune limite, c’est-à-dire le début du signal). Par défaut : None.
xmax (float) – X_MAX. Borne x supérieure (vide pour aucune limite, c’est-à-dire la fin du signal). Par défaut : None.

Renvoie:

Nouvelle instance de FWHMParam.

class cdl.param.HighPassFilterParam[source]

Paramètres de filtre passe-haut

method

Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.

Type:: guidata.dataset.dataitems.ChoiceItem

order

Ordre du filtre. Entier supérieur à 1. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

f_cut0

Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

f_cut1

Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

rp

Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

rs

Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, order: int, f_cut0: float, f_cut1: float, rp: float, rs: float) → cdl.computation.signal.HighPassFilterParam

Renvoie une nouvelle instance de HighPassFilterParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.
order (int) – Ordre du filtre. Entier supérieur à 1. Par défaut : 3.
f_cut0 (float) – Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
f_cut1 (float) – Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
rp (float) – Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.
rs (float) – Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Renvoie:

Nouvelle instance de HighPassFilterParam.

class cdl.param.InterpolationParam[source]

Paramètres d’interpolation

method

Méthode d’interpolation. Sélection unique parmi : “linear”, “spline”, “quadratic”, “cubic”, “barycentric”, “pchip”. Par défaut : “linear”.

Type:: guidata.dataset.dataitems.ChoiceItem

fill_value

Valeur de remplissage. Valeur à utiliser pour les points en dehors du domaine d’interpolation (utilisé uniquement avec les méthodes linéaire, cubique et pchip). Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, fill_value: float) → cdl.computation.signal.InterpolationParam

Renvoie une nouvelle instance de InterpolationParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode d’interpolation. Sélection unique parmi : “linear”, “spline”, “quadratic”, “cubic”, “barycentric”, “pchip”. Par défaut : “linear”.
fill_value (float) – Valeur de remplissage. Valeur à utiliser pour les points en dehors du domaine d’interpolation (utilisé uniquement avec les méthodes linéaire, cubique et pchip). Par défaut : None.

Renvoie:

Nouvelle instance de InterpolationParam.

class cdl.param.LowPassFilterParam[source]

Paramètres de filtre passe-bas

method

Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.

Type:: guidata.dataset.dataitems.ChoiceItem

order

Ordre du filtre. Entier supérieur à 1. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

f_cut0

Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

f_cut1

Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

rp

Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

rs

Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, order: int, f_cut0: float, f_cut1: float, rp: float, rs: float) → cdl.computation.signal.LowPassFilterParam

Renvoie une nouvelle instance de LowPassFilterParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode de filtrage. Sélection unique parmi : “bessel”, “butter”, “cheby1”, “cheby2”, “ellip”. Par défaut : “bessel”.
order (int) – Ordre du filtre. Entier supérieur à 1. Par défaut : 3.
f_cut0 (float) – Fréquence de coupure basse. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
f_cut1 (float) – Fréquence de coupure haute. Flottant supérieur à 0, non nul, unité : hz. Par défaut : None.
rp (float) – Ondulation de la bande passante. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.
rs (float) – Atténuation de la bande d’arrêt. Flottant supérieur à 0, non nul, unité : db. Par défaut : 1.

Renvoie:

Nouvelle instance de LowPassFilterParam.

class cdl.param.PeakDetectionParam[source]

Paramètres de détection de pics

threshold

Seuil. Entier compris entre 0 et 100, unité : %. Par défaut : 30.

Type:: guidata.dataset.dataitems.IntItem

min_dist

Distance minimale. Entier supérieur à 1, unité : points. Par défaut : 1.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(threshold: int, min_dist: int) → cdl.computation.signal.PeakDetectionParam

Renvoie une nouvelle instance de PeakDetectionParam avec les champs initialisés aux valeurs données.

Paramètres:

threshold (int) – Seuil. Entier compris entre 0 et 100, unité : %. Par défaut : 30.
min_dist (int) – Distance minimale. Entier supérieur à 1, unité : points. Par défaut : 1.

Renvoie:

Nouvelle instance de PeakDetectionParam.

class cdl.param.PolynomialFitParam[source]

Paramètres de régression polynomiale

degree

Degré. Entier compris entre 1 et 10. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(degree: int) → cdl.computation.signal.PolynomialFitParam

Renvoie une nouvelle instance de PolynomialFitParam avec les champs initialisés aux valeurs données.

Paramètres:: degree (int) – Degré. Entier compris entre 1 et 10. Par défaut : 3.
Renvoie:: Nouvelle instance de PolynomialFitParam.

class cdl.param.PowerParam[source]

Paramètres de puissance

power

Puissance. Par défaut : 2.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(power: float) → cdl.computation.signal.PowerParam

Renvoie une nouvelle instance de PowerParam avec les champs initialisés aux valeurs données.

Paramètres:: power (float) – Puissance. Par défaut : 2.0.
Renvoie:: Nouvelle instance de PowerParam.

class cdl.param.ResamplingParam[source]

Paramètres de rééchantillonnage

method

Méthode d’interpolation. Sélection unique parmi : “linear”, “spline”, “quadratic”, “cubic”, “barycentric”, “pchip”. Par défaut : “linear”.

Type:: guidata.dataset.dataitems.ChoiceItem

fill_value

Valeur de remplissage. Valeur à utiliser pour les points en dehors du domaine d’interpolation (utilisé uniquement avec les méthodes linéaire, cubique et pchip). Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

xmin

X_min. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

xmax

X_max. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

mode

Sélection unique parmi : “dx”, “nbpts”. Par défaut : “nbpts”.

Type:: guidata.dataset.dataitems.ChoiceItem

dx

ΔX. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

nbpts

Nombre de points. Par défaut : None.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(method: str, fill_value: float, xmin: float, xmax: float, mode: str, dx: float, nbpts: int) → cdl.computation.signal.ResamplingParam

Renvoie une nouvelle instance de ResamplingParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode d’interpolation. Sélection unique parmi : “linear”, “spline”, “quadratic”, “cubic”, “barycentric”, “pchip”. Par défaut : “linear”.
fill_value (float) – Valeur de remplissage. Valeur à utiliser pour les points en dehors du domaine d’interpolation (utilisé uniquement avec les méthodes linéaire, cubique et pchip). Par défaut : None.
xmin (float) – X_min. Par défaut : None.
xmax (float) – X_max. Par défaut : None.
mode (str) – Sélection unique parmi : “dx”, “nbpts”. Par défaut : “nbpts”.
dx (float) – ΔX. Par défaut : None.
nbpts (int) – Nombre de points. Par défaut : None.

Renvoie:

Nouvelle instance de ResamplingParam.

class cdl.param.WindowingParam[source]

Paramètres de fenêtrage

method

Méthode. Sélection unique parmi : “barthann”, “bartlett”, “blackman”, “blackman-harris”, “bohman”, “boxcar”, “cosine”, “exponential”, “flat-top”, “gaussian”, “hamming”, “hanning”, “kaiser”, “lanczos”, “nuttall”, “parzen”, “rectangular”, “taylor”, “tukey”. Par défaut : “hamming”.

Type:: guidata.dataset.dataitems.ChoiceItem

alpha

Paramètre de forme de la fonction de fenêtrage de tukey. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

beta

Paramètre de forme de la fonction de fenêtrage de kaiser. Par défaut : 14.0.

Type:: guidata.dataset.dataitems.FloatItem

sigma

Paramètre de forme de la fonction de fenêtrage gaussienne. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(method: str, alpha: float, beta: float, sigma: float) → cdl.computation.signal.WindowingParam

Renvoie une nouvelle instance de WindowingParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode. Sélection unique parmi : “barthann”, “bartlett”, “blackman”, “blackman-harris”, “bohman”, “boxcar”, “cosine”, “exponential”, “flat-top”, “gaussian”, “hamming”, “hanning”, “kaiser”, “lanczos”, “nuttall”, “parzen”, “rectangular”, “taylor”, “tukey”. Par défaut : “hamming”.
alpha (float) – Paramètre de forme de la fonction de fenêtrage de tukey. Par défaut : 0.5.
beta (float) – Paramètre de forme de la fonction de fenêtrage de kaiser. Par défaut : 14.0.
sigma (float) – Paramètre de forme de la fonction de fenêtrage gaussienne. Par défaut : 0.5.

Renvoie:

Nouvelle instance de WindowingParam.

class cdl.param.XYCalibrateParam[source]

Paramètres de calibration du signal

axis

Étalonner. Sélection unique parmi : “x”, “y”. Par défaut : “y”.

Type:: guidata.dataset.dataitems.ChoiceItem

a

Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

b

Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(axis: str, a: float, b: float) → cdl.computation.signal.XYCalibrateParam

Renvoie une nouvelle instance de XYCalibrateParam avec les champs initialisés aux valeurs données.

Paramètres:

axis (str) – Étalonner. Sélection unique parmi : “x”, “y”. Par défaut : “y”.
a (float) – Par défaut : 1.0.
b (float) – Par défaut : 0.0.

Renvoie:

Nouvelle instance de XYCalibrateParam.

Paramètres des images#

Paramètres de base des images#

class cdl.param.AverageProfileParam[source]

Paramètres de profil horizontal ou vertical moyen

direction

Sélection unique parmi : “horizontal”, “vertical”. Par défaut : “horizontal”.

Type:: guidata.dataset.dataitems.ChoiceItem

row1

Ligne 1. Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

row2

Ligne 2. Entier supérieur à -1. Par défaut : -1.

Type:: guidata.dataset.dataitems.IntItem

col1

Colonne 1. Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

col2

Colonne 2. Entier supérieur à -1. Par défaut : -1.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(direction: str, row1: int, row2: int, col1: int, col2: int) → cdl.computation.image.AverageProfileParam

Renvoie une nouvelle instance de AverageProfileParam avec les champs initialisés aux valeurs données.

Paramètres:

direction (str) – Sélection unique parmi : “horizontal”, “vertical”. Par défaut : “horizontal”.
row1 (int) – Ligne 1. Entier supérieur à 0. Par défaut : 0.
row2 (int) – Ligne 2. Entier supérieur à -1. Par défaut : -1.
col1 (int) – Colonne 1. Entier supérieur à 0. Par défaut : 0.
col2 (int) – Colonne 2. Entier supérieur à -1. Par défaut : -1.

Renvoie:

Nouvelle instance de AverageProfileParam.

class cdl.param.BinningParam[source]

Paramètres de binning

sx

Nombre de pixels (X). Nombre de pixels adjacents à regrouper le long de l’axe des x. Entier supérieur à 2. Par défaut : 2.

Type:: guidata.dataset.dataitems.IntItem

sy

Nombre de pixels (Y). Nombre de pixels adjacents à regrouper le long de l’axe des y. Entier supérieur à 2. Par défaut : 2.

Type:: guidata.dataset.dataitems.IntItem

operation

Opération. Sélection unique parmi : “sum”, “average”, “median”, “min”, “max”. Par défaut : “sum”.

Type:: guidata.dataset.dataitems.ChoiceItem

dtype_str

Type de données. Type de données de l’image générée. Sélection unique parmi : “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.

Type:: guidata.dataset.dataitems.ChoiceItem

change_pixel_size

Modification de la taille des pixels de sorte que les dimensions de l’images restent les mêmes après l’opération. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(sx: int, sy: int, operation: str, dtype_str: str, change_pixel_size: bool) → cdl.computation.image.BinningParam

Renvoie une nouvelle instance de BinningParam avec les champs initialisés aux valeurs données.

Paramètres:

sx (int) – Nombre de pixels (X). Nombre de pixels adjacents à regrouper le long de l’axe des x. Entier supérieur à 2. Par défaut : 2.
sy (int) – Nombre de pixels (Y). Nombre de pixels adjacents à regrouper le long de l’axe des y. Entier supérieur à 2. Par défaut : 2.
operation (str) – Opération. Sélection unique parmi : “sum”, “average”, “median”, “min”, “max”. Par défaut : “sum”.
dtype_str (str) – Type de données. Type de données de l’image générée. Sélection unique parmi : “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.
change_pixel_size (bool) – Modification de la taille des pixels de sorte que les dimensions de l’images restent les mêmes après l’opération. Par défaut : False.

Renvoie:

Nouvelle instance de BinningParam.

class cdl.param.ButterworthParam[source]

Paramètres de filtre Butterworth

cut_off

Fréquence de coupure relative. Fréquence de coupure relative. Flottant compris entre 0.0 et 0.5. Par défaut : 0.005.

Type:: guidata.dataset.dataitems.FloatItem

high_pass

Si vrai, appliquer un filtre passe-haut au lieu d’un filtre passe-bas. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

order

Ordre. Ordre du filtre de butterworth. Entier supérieur à 1. Par défaut : 2.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(cut_off: float, high_pass: bool, order: int) → cdl.computation.image.ButterworthParam

Renvoie une nouvelle instance de ButterworthParam avec les champs initialisés aux valeurs données.

Paramètres:

cut_off (float) – Fréquence de coupure relative. Fréquence de coupure relative. Flottant compris entre 0.0 et 0.5. Par défaut : 0.005.
high_pass (bool) – Si vrai, appliquer un filtre passe-haut au lieu d’un filtre passe-bas. Par défaut : False.
order (int) – Ordre. Ordre du filtre de butterworth. Entier supérieur à 1. Par défaut : 2.

Renvoie:

Nouvelle instance de ButterworthParam.

class cdl.param.DataTypeIParam[source]

Convertir les paramètres de type de données de l’image

dtype_str

Type de données de destination. Type de données de l’image générée. Sélection unique parmi : “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “float32”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(dtype_str: str) → cdl.computation.image.DataTypeIParam

Renvoie une nouvelle instance de DataTypeIParam avec les champs initialisés aux valeurs données.

Paramètres:: dtype_str (str) – Type de données de destination. Type de données de l’image générée. Sélection unique parmi : “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “float32”.
Renvoie:: Nouvelle instance de DataTypeIParam.

class cdl.param.FlatFieldParam[source]

Paramètres de correction de champ plat

threshold

Seuil. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(threshold: float) → cdl.computation.image.FlatFieldParam

Renvoie une nouvelle instance de FlatFieldParam avec les champs initialisés aux valeurs données.

Paramètres:: threshold (float) – Seuil. Par défaut : 0.0.
Renvoie:: Nouvelle instance de FlatFieldParam.

class cdl.param.GridParam[source]

Paramètres de grille

direction

Distribuer selon les. Sélection unique parmi : “col”, “row”. Par défaut : “col”.

Type:: guidata.dataset.dataitems.ChoiceItem

cols

Colonnes. Entier, non nul. Par défaut : 1.

Type:: guidata.dataset.dataitems.IntItem

rows

Lignes. Entier, non nul. Par défaut : 1.

Type:: guidata.dataset.dataitems.IntItem

colspac

Espace entre chaque colonne. Flottant supérieur à 0.0. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

rowspac

Espace entre chaque ligne. Flottant supérieur à 0.0. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(direction: str, cols: int, rows: int, colspac: float, rowspac: float) → cdl.computation.image.GridParam

Renvoie une nouvelle instance de GridParam avec les champs initialisés aux valeurs données.

Paramètres:

direction (str) – Distribuer selon les. Sélection unique parmi : “col”, “row”. Par défaut : “col”.
cols (int) – Colonnes. Entier, non nul. Par défaut : 1.
rows (int) – Lignes. Entier, non nul. Par défaut : 1.
colspac (float) – Espace entre chaque colonne. Flottant supérieur à 0.0. Par défaut : 0.0.
rowspac (float) – Espace entre chaque ligne. Flottant supérieur à 0.0. Par défaut : 0.0.

Renvoie:

Nouvelle instance de GridParam.

class cdl.param.HoughCircleParam[source]

Paramètres de transformation de Hough circulaire

min_radius

Rayon_min. Entier supérieur à 0, non nul, unité : pixels. Par défaut : None.

Type:: guidata.dataset.dataitems.IntItem

max_radius

Rayon_max. Entier supérieur à 0, non nul, unité : pixels. Par défaut : None.

Type:: guidata.dataset.dataitems.IntItem

min_distance

Distance minimale. Entier supérieur à 0. Par défaut : None.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(min_radius: int, max_radius: int, min_distance: int) → cdl.computation.image.HoughCircleParam

Renvoie une nouvelle instance de HoughCircleParam avec les champs initialisés aux valeurs données.

Paramètres:

min_radius (int) – Rayon_min. Entier supérieur à 0, non nul, unité : pixels. Par défaut : None.
max_radius (int) – Rayon_max. Entier supérieur à 0, non nul, unité : pixels. Par défaut : None.
min_distance (int) – Distance minimale. Entier supérieur à 0. Par défaut : None.

Renvoie:

Nouvelle instance de HoughCircleParam.

class cdl.param.LineProfileParam[source]

Paramètres de profil horizontal ou vertical

direction

Sélection unique parmi : “horizontal”, “vertical”. Par défaut : “horizontal”.

Type:: guidata.dataset.dataitems.ChoiceItem

row

Ligne. Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

col

Colonne. Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(direction: str, row: int, col: int) → cdl.computation.image.LineProfileParam

Renvoie une nouvelle instance de LineProfileParam avec les champs initialisés aux valeurs données.

Paramètres:

direction (str) – Sélection unique parmi : “horizontal”, “vertical”. Par défaut : “horizontal”.
row (int) – Ligne. Entier supérieur à 0. Par défaut : 0.
col (int) – Colonne. Entier supérieur à 0. Par défaut : 0.

Renvoie:

Nouvelle instance de LineProfileParam.

class cdl.param.LogP1Param[source]

Paramètres de log10

n

Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(n: float) → cdl.computation.image.LogP1Param

Renvoie une nouvelle instance de LogP1Param avec les champs initialisés aux valeurs données.

Paramètres:: n (float) – Par défaut : None.
Renvoie:: Nouvelle instance de LogP1Param.

class cdl.param.RadialProfileParam[source]

Paramètres de profil radial

center

Position du centre. Sélection unique parmi : “centroid”, “center”, “user”. Par défaut : “centroid”.

Type:: guidata.dataset.dataitems.ChoiceItem

x0

X_Centre. Flottant, unité : pixel. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

y0

X_Centre. Flottant, unité : pixel. Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(center: str, x0: float, y0: float) → cdl.computation.image.RadialProfileParam

Renvoie une nouvelle instance de RadialProfileParam avec les champs initialisés aux valeurs données.

Paramètres:

center (str) – Position du centre. Sélection unique parmi : “centroid”, “center”, “user”. Par défaut : “centroid”.
x0 (float) – X_Centre. Flottant, unité : pixel. Par défaut : None.
y0 (float) – X_Centre. Flottant, unité : pixel. Par défaut : None.

Renvoie:

Nouvelle instance de RadialProfileParam.

update_from_image(obj: ImageObj) → None[source]: Mettre à jour les paramètres à partir de l’image

choice_callback(item, value)[source]: Callback pour l’item de choix

class cdl.param.ResizeParam[source]

Paramètres de redimensionnement

zoom

Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

mode

Sélection unique parmi : “constant”, “nearest”, “reflect”, “wrap”. Par défaut : “constant”.

Type:: guidata.dataset.dataitems.ChoiceItem

cval

Valeur utilisée pour les points situés en dehors des frontières de l’image d’origine (si le mode est “constant”). Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

prefilter

Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

order

Ordre. Ordre de l’interpolation de type spline. Entier compris entre 0 et 5. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(zoom: float, mode: str, cval: float, prefilter: bool, order: int) → cdl.computation.image.ResizeParam

Renvoie une nouvelle instance de ResizeParam avec les champs initialisés aux valeurs données.

Paramètres:

zoom (float) – Par défaut : None.
mode (str) – Sélection unique parmi : “constant”, “nearest”, “reflect”, “wrap”. Par défaut : “constant”.
cval (float) – Valeur utilisée pour les points situés en dehors des frontières de l’image d’origine (si le mode est “constant”). Par défaut : 0.0.
prefilter (bool) – Par défaut : True.
order (int) – Ordre. Ordre de l’interpolation de type spline. Entier compris entre 0 et 5. Par défaut : 3.

Renvoie:

Nouvelle instance de ResizeParam.

class cdl.param.RotateParam[source]

Paramètres de rotation

angle

Angle (°). Par défaut : None.

Type:: guidata.dataset.dataitems.FloatItem

mode

Sélection unique parmi : “constant”, “nearest”, “reflect”, “wrap”. Par défaut : “constant”.

Type:: guidata.dataset.dataitems.ChoiceItem

cval

Valeur utilisée pour les points situés en dehors des frontières de l’image d’origine (si le mode est “constant”). Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

reshape

Redimensionner l’image de destination de sorte qu’elle puisse contenir la totalité de l’image source. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

prefilter

Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

order

Ordre. Ordre de l’interpolation de type spline. Entier compris entre 0 et 5. Par défaut : 3.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(angle: float, mode: str, cval: float, reshape: bool, prefilter: bool, order: int) → cdl.computation.image.RotateParam

Renvoie une nouvelle instance de RotateParam avec les champs initialisés aux valeurs données.

Paramètres:

angle (float) – Angle (°). Par défaut : None.
mode (str) – Sélection unique parmi : “constant”, “nearest”, “reflect”, “wrap”. Par défaut : “constant”.
cval (float) – Valeur utilisée pour les points situés en dehors des frontières de l’image d’origine (si le mode est “constant”). Par défaut : 0.0.
reshape (bool) – Redimensionner l’image de destination de sorte qu’elle puisse contenir la totalité de l’image source. Par défaut : False.
prefilter (bool) – Par défaut : True.
order (int) – Ordre. Ordre de l’interpolation de type spline. Entier compris entre 0 et 5. Par défaut : 3.

Renvoie:

Nouvelle instance de RotateParam.

class cdl.param.SegmentProfileParam[source]

Paramètres de profil de segment

row1

Ligne (début). Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

col1

Colonne (début). Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

row2

Ligne (fin). Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

col2

Colonne (fin). Entier supérieur à 0. Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(row1: int, col1: int, row2: int, col2: int) → cdl.computation.image.SegmentProfileParam

Renvoie une nouvelle instance de SegmentProfileParam avec les champs initialisés aux valeurs données.

Paramètres:

row1 (int) – Ligne (début). Entier supérieur à 0. Par défaut : 0.
col1 (int) – Colonne (début). Entier supérieur à 0. Par défaut : 0.
row2 (int) – Ligne (fin). Entier supérieur à 0. Par défaut : 0.
col2 (int) – Colonne (fin). Entier supérieur à 0. Par défaut : 0.

Renvoie:

Nouvelle instance de SegmentProfileParam.

class cdl.param.ZCalibrateParam[source]

Paramètres de calibration linéaire de l’image

a

Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

b

Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(a: float, b: float) → cdl.computation.image.ZCalibrateParam

Renvoie une nouvelle instance de ZCalibrateParam avec les champs initialisés aux valeurs données.

Paramètres:

a (float) – Par défaut : 1.0.
b (float) – Par défaut : 0.0.

Renvoie:

Nouvelle instance de ZCalibrateParam.

Paramètres de détection#

class cdl.param.BlobDOGParam[source]

Détection de taches par méthode de différence de gaussiennes

min_sigma

σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

max_sigma

σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.

Type:: guidata.dataset.dataitems.FloatItem

threshold_rel

Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.

Type:: guidata.dataset.dataitems.FloatItem

overlap

Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

exclude_border

Si le réglage est actif, exclure les taches de la bordure de l’image. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(min_sigma: float, max_sigma: float, threshold_rel: float, overlap: float, exclude_border: bool) → cdl.computation.image.detection.BlobDOGParam

Renvoie une nouvelle instance de BlobDOGParam avec les champs initialisés aux valeurs données.

Paramètres:

min_sigma (float) – σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.
max_sigma (float) – σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.
threshold_rel (float) – Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.
overlap (float) – Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.
exclude_border (bool) – Si le réglage est actif, exclure les taches de la bordure de l’image. Par défaut : True.

Renvoie:

Nouvelle instance de BlobDOGParam.

class cdl.param.BlobDOHParam[source]

Détection de taches par méthode du déterminant du Hessien

min_sigma

σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

max_sigma

σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.

Type:: guidata.dataset.dataitems.FloatItem

threshold_rel

Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.

Type:: guidata.dataset.dataitems.FloatItem

overlap

Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

log_scale

Les valeurs intermédiaires d’écart-type peuvent être interpolées selon une échelle linéaire ou logarithmique. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(min_sigma: float, max_sigma: float, threshold_rel: float, overlap: float, log_scale: bool) → cdl.computation.image.detection.BlobDOHParam

Renvoie une nouvelle instance de BlobDOHParam avec les champs initialisés aux valeurs données.

Paramètres:

min_sigma (float) – σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.
max_sigma (float) – σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.
threshold_rel (float) – Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.
overlap (float) – Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.
log_scale (bool) – Les valeurs intermédiaires d’écart-type peuvent être interpolées selon une échelle linéaire ou logarithmique. Par défaut : False.

Renvoie:

Nouvelle instance de BlobDOHParam.

class cdl.param.BlobLOGParam[source]

Détection de taches par méthode du Laplacien de gaussiennes

min_sigma

σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

max_sigma

σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.

Type:: guidata.dataset.dataitems.FloatItem

threshold_rel

Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.

Type:: guidata.dataset.dataitems.FloatItem

overlap

Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

log_scale

Les valeurs intermédiaires d’écart-type peuvent être interpolées selon une échelle linéaire ou logarithmique. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

exclude_border

Si le réglage est actif, exclure les taches de la bordure de l’image. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(min_sigma: float, max_sigma: float, threshold_rel: float, overlap: float, log_scale: bool, exclude_border: bool) → cdl.computation.image.detection.BlobLOGParam

Renvoie une nouvelle instance de BlobLOGParam avec les champs initialisés aux valeurs données.

Paramètres:

min_sigma (float) – σ_min. L’écart-type minimal pour le noyau gaussien. Cette valeur doit être faible pour détecter de petites taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.
max_sigma (float) – σ_max. L’écart-type maximal pour le noyau gaussien. Cette valeur doit être élevée pour détecter de grandes taches. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 30.0.
threshold_rel (float) – Seuil relatif. Intensité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.2.
overlap (float) – Recouvrement. Si deux taches ont un taux de recouvrement supérieur à ce seuil, alors la plus petite tache est éliminée. Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.
log_scale (bool) – Les valeurs intermédiaires d’écart-type peuvent être interpolées selon une échelle linéaire ou logarithmique. Par défaut : False.
exclude_border (bool) – Si le réglage est actif, exclure les taches de la bordure de l’image. Par défaut : True.

Renvoie:

Nouvelle instance de BlobLOGParam.

class cdl.param.BlobOpenCVParam[source]

Détection de taches par OpenCV

min_threshold

Seuil min. Le seuil minimum entre les maxima et minima locaux. Ce paramètre n’affecte pas la qualité des taches, mais seulement leur nombre. Un seuil bas donne un nombre plus important de taches. Flottant supérieur à 0.0. Par défaut : 10.0.

Type:: guidata.dataset.dataitems.FloatItem

max_threshold

Seuil max. Le seuil maximum entre les maxima et minima locaux. Ce paramètre n’affecte pas la qualité des taches, mais seulement leur nombre. Un seuil bas donne un nombre plus important de taches. Flottant supérieur à 0.0. Par défaut : 200.0.

Type:: guidata.dataset.dataitems.FloatItem

min_repeatability

Répétabilité min. Le nombre minimum de fois qu’une tache doit être détectée dans une séquence d’images pour être considérée valide. Entier supérieur à 1. Par défaut : 2.

Type:: guidata.dataset.dataitems.IntItem

min_dist_between_blobs

Distance min. entre taches. La distance minimale entre deux taches. Si deux taches sont détectées à une distance inférieure à celle-ci, alors la plus petite tache est éliminée. Flottant supérieur à 0.0, non nul. Par défaut : 10.0.

Type:: guidata.dataset.dataitems.FloatItem

filter_by_color

Si vrai, l’image est filtrée par couleur au lieu d’intensité. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

blob_color

Couleur de la tache. La couleur des taches à détecter (0 pour les taches foncées, 255 pour les taches claires). Par défaut : 0.

Type:: guidata.dataset.dataitems.IntItem

filter_by_area

Si vrai, l’image est filtrée par l’aire des taches. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

min_area

Aire min. L’aire minimale des taches. Flottant supérieur à 0.0. Par défaut : 25.0.

Type:: guidata.dataset.dataitems.FloatItem

max_area

Aire max. L’aire maximale des taches. Flottant supérieur à 0.0. Par défaut : 500.0.

Type:: guidata.dataset.dataitems.FloatItem

filter_by_circularity

Si vrai, l’image est filtrée par la circularité des taches. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

min_circularity

Circularité min. La circularité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.8.

Type:: guidata.dataset.dataitems.FloatItem

max_circularity

Circularité max. La circularité maximale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

filter_by_inertia

Si vrai, l’image est filtrée par l’inertie des taches. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

min_inertia_ratio

Ratio d’inertie min. Le ratio d’inertie minimal des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.6.

Type:: guidata.dataset.dataitems.FloatItem

max_inertia_ratio

Ratio d’inertie max. Le ratio d’inertie maximal des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

filter_by_convexity

Si vrai, l’image est filtrée par la convexité des taches. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

min_convexity

Convexité min. La convexité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.8.

Type:: guidata.dataset.dataitems.FloatItem

max_convexity

Convexité max. La convexité maximale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(min_threshold: float, max_threshold: float, min_repeatability: int, min_dist_between_blobs: float, filter_by_color: bool, blob_color: int, filter_by_area: bool, min_area: float, max_area: float, filter_by_circularity: bool, min_circularity: float, max_circularity: float, filter_by_inertia: bool, min_inertia_ratio: float, max_inertia_ratio: float, filter_by_convexity: bool, min_convexity: float, max_convexity: float) → cdl.computation.image.detection.BlobOpenCVParam

Renvoie une nouvelle instance de BlobOpenCVParam avec les champs initialisés aux valeurs données.

Paramètres:

min_threshold (float) – Seuil min. Le seuil minimum entre les maxima et minima locaux. Ce paramètre n’affecte pas la qualité des taches, mais seulement leur nombre. Un seuil bas donne un nombre plus important de taches. Flottant supérieur à 0.0. Par défaut : 10.0.
max_threshold (float) – Seuil max. Le seuil maximum entre les maxima et minima locaux. Ce paramètre n’affecte pas la qualité des taches, mais seulement leur nombre. Un seuil bas donne un nombre plus important de taches. Flottant supérieur à 0.0. Par défaut : 200.0.
min_repeatability (int) – Répétabilité min. Le nombre minimum de fois qu’une tache doit être détectée dans une séquence d’images pour être considérée valide. Entier supérieur à 1. Par défaut : 2.
min_dist_between_blobs (float) – Distance min. entre taches. La distance minimale entre deux taches. Si deux taches sont détectées à une distance inférieure à celle-ci, alors la plus petite tache est éliminée. Flottant supérieur à 0.0, non nul. Par défaut : 10.0.
filter_by_color (bool) – Si vrai, l’image est filtrée par couleur au lieu d’intensité. Par défaut : True.
blob_color (int) – Couleur de la tache. La couleur des taches à détecter (0 pour les taches foncées, 255 pour les taches claires). Par défaut : 0.
filter_by_area (bool) – Si vrai, l’image est filtrée par l’aire des taches. Par défaut : True.
min_area (float) – Aire min. L’aire minimale des taches. Flottant supérieur à 0.0. Par défaut : 25.0.
max_area (float) – Aire max. L’aire maximale des taches. Flottant supérieur à 0.0. Par défaut : 500.0.
filter_by_circularity (bool) – Si vrai, l’image est filtrée par la circularité des taches. Par défaut : False.
min_circularity (float) – Circularité min. La circularité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.8.
max_circularity (float) – Circularité max. La circularité maximale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.
filter_by_inertia (bool) – Si vrai, l’image est filtrée par l’inertie des taches. Par défaut : False.
min_inertia_ratio (float) – Ratio d’inertie min. Le ratio d’inertie minimal des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.6.
max_inertia_ratio (float) – Ratio d’inertie max. Le ratio d’inertie maximal des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.
filter_by_convexity (bool) – Si vrai, l’image est filtrée par la convexité des taches. Par défaut : False.
min_convexity (float) – Convexité min. La convexité minimale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 0.8.
max_convexity (float) – Convexité max. La convexité maximale des taches. Flottant compris entre 0.0 et 1.0. Par défaut : 1.0.

Renvoie:

Nouvelle instance de BlobOpenCVParam.

class cdl.param.ContourShapeParam[source]

Paramètres de forme de contour

threshold

Seuil relatif. Seuil de détection, relatif à la différence entre le maximum et le minimum des données de l’image. Flottant compris entre 0.1 et 0.9. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

shape

Forme. Sélection unique parmi : “ellipse”, “circle”, “polygon”. Par défaut : “ellipse”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(threshold: float, shape: str) → cdl.computation.image.detection.ContourShapeParam

Renvoie une nouvelle instance de ContourShapeParam avec les champs initialisés aux valeurs données.

Paramètres:

threshold (float) – Seuil relatif. Seuil de détection, relatif à la différence entre le maximum et le minimum des données de l’image. Flottant compris entre 0.1 et 0.9. Par défaut : 0.5.
shape (str) – Forme. Sélection unique parmi : “ellipse”, “circle”, “polygon”. Par défaut : “ellipse”.

Renvoie:

Nouvelle instance de ContourShapeParam.

class cdl.param.Peak2DDetectionParam[source]

Paramètres de détection de pics

threshold

Seuil relatif. Seuil de détection, relatif à la différence entre le maximum et le minimum des données de l’image. Flottant compris entre 0.1 et 0.9. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

size

Taille du voisinage. Taille de la fenêtre glissante utilisée dans l’algorithme de filtrage maximum/minimum. Entier supérieur à 1, unité : pixels. Par défaut : 10.

Type:: guidata.dataset.dataitems.IntItem

create_rois

Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(threshold: float, size: int, create_rois: bool) → cdl.computation.image.detection.Peak2DDetectionParam

Renvoie une nouvelle instance de Peak2DDetectionParam avec les champs initialisés aux valeurs données.

Paramètres:

threshold (float) – Seuil relatif. Seuil de détection, relatif à la différence entre le maximum et le minimum des données de l’image. Flottant compris entre 0.1 et 0.9. Par défaut : 0.5.
size (int) – Taille du voisinage. Taille de la fenêtre glissante utilisée dans l’algorithme de filtrage maximum/minimum. Entier supérieur à 1, unité : pixels. Par défaut : 10.
create_rois (bool) – Par défaut : True.

Renvoie:

Nouvelle instance de Peak2DDetectionParam.

Paramètres de détection de contours#

class cdl.param.CannyParam[source]

Paramètres de filtre Canny

sigma

Ecart-type du filtrage gaussien. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

low_threshold

Seuil bas. Borne inférieure pour le seuillage par hystérésis (liaison des contours). Flottant supérieur à 0. Par défaut : 0.1.

Type:: guidata.dataset.dataitems.FloatItem

high_threshold

Seuil haut. Borne supérieure pour le seuillage par hystérésis (liaison des contours). Flottant supérieur à 0. Par défaut : 0.9.

Type:: guidata.dataset.dataitems.FloatItem

use_quantiles

Interprète les seuils bas et haut en tant que quantiles des niveaux des contours, au lieu de valeurs absolues des contours. Si le réglage est actif, alors les seuils doivent être compris entre 0 et 1. Par défaut : True.

Type:: guidata.dataset.dataitems.BoolItem

mode

Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “constant”.

Type:: guidata.dataset.dataitems.ChoiceItem

cval

Valeur de remplissage si le mode est constant. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(sigma: float, low_threshold: float, high_threshold: float, use_quantiles: bool, mode: str, cval: float) → cdl.computation.image.edges.CannyParam

Renvoie une nouvelle instance de CannyParam avec les champs initialisés aux valeurs données.

Paramètres:

sigma (float) – Ecart-type du filtrage gaussien. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.
low_threshold (float) – Seuil bas. Borne inférieure pour le seuillage par hystérésis (liaison des contours). Flottant supérieur à 0. Par défaut : 0.1.
high_threshold (float) – Seuil haut. Borne supérieure pour le seuillage par hystérésis (liaison des contours). Flottant supérieur à 0. Par défaut : 0.9.
use_quantiles (bool) – Interprète les seuils bas et haut en tant que quantiles des niveaux des contours, au lieu de valeurs absolues des contours. Si le réglage est actif, alors les seuils doivent être compris entre 0 et 1. Par défaut : True.
mode (str) – Sélection unique parmi : “reflect”, “constant”, “nearest”, “mirror”, “wrap”. Par défaut : “constant”.
cval (float) – Valeur de remplissage si le mode est constant. Par défaut : 0.0.

Renvoie:

Nouvelle instance de CannyParam.

Paramètres de correction d’exposition#

class cdl.param.AdjustGammaParam[source]

Paramètres d’ajustement gamma

gamma

Facteur de correction gamma (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

gain

Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(gamma: float, gain: float) → cdl.computation.image.exposure.AdjustGammaParam

Renvoie une nouvelle instance de AdjustGammaParam avec les champs initialisés aux valeurs données.

Paramètres:

gamma (float) – Facteur de correction gamma (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.
gain (float) – Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.

Renvoie:

Nouvelle instance de AdjustGammaParam.

class cdl.param.AdjustLogParam[source]

Paramètres d’ajustement logarithmique

gain

Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

inv

Si vrai, appliquer une transformation logarithmique inverse. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(gain: float, inv: bool) → cdl.computation.image.exposure.AdjustLogParam

Renvoie une nouvelle instance de AdjustLogParam avec les champs initialisés aux valeurs données.

Paramètres:

gain (float) – Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 1.0.
inv (bool) – Si vrai, appliquer une transformation logarithmique inverse. Par défaut : False.

Renvoie:

Nouvelle instance de AdjustLogParam.

class cdl.param.AdjustSigmoidParam[source]

Paramètres d’ajustement sigmoïde

cutoff

Valeur de coupure (plus la valeur est élevée, plus le contraste est important). Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.

Type:: guidata.dataset.dataitems.FloatItem

gain

Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 10.0.

Type:: guidata.dataset.dataitems.FloatItem

inv

Si vrai, appliquer une transformation sigmoïde inverse. Par défaut : False.

Type:: guidata.dataset.dataitems.BoolItem

classmethod create(cutoff: float, gain: float, inv: bool) → cdl.computation.image.exposure.AdjustSigmoidParam

Renvoie une nouvelle instance de AdjustSigmoidParam avec les champs initialisés aux valeurs données.

Paramètres:

cutoff (float) – Valeur de coupure (plus la valeur est élevée, plus le contraste est important). Flottant compris entre 0.0 et 1.0. Par défaut : 0.5.
gain (float) – Facteur de gain (plus la valeur est élevée, plus le contraste est important). Flottant supérieur à 0.0. Par défaut : 10.0.
inv (bool) – Si vrai, appliquer une transformation sigmoïde inverse. Par défaut : False.

Renvoie:

Nouvelle instance de AdjustSigmoidParam.

class cdl.param.EqualizeAdaptHistParam[source]

Paramètres d’égalisation d’histogramme adaptatif

nbins

Nombre de classes. Nombre de classes de l’histogramme des niveaux de l’image. Entier supérieur à 1. Par défaut : 256.

Type:: guidata.dataset.dataitems.IntItem

clip_limit

Écrêtage limite. Valeur d’écrêtage (plus la valeur est élevée, plus le contraste est important). Flottant compris entre 0.0 et 1.0. Par défaut : 0.01.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(nbins: int, clip_limit: float) → cdl.computation.image.exposure.EqualizeAdaptHistParam

Renvoie une nouvelle instance de EqualizeAdaptHistParam avec les champs initialisés aux valeurs données.

Paramètres:

nbins (int) – Nombre de classes. Nombre de classes de l’histogramme des niveaux de l’image. Entier supérieur à 1. Par défaut : 256.
clip_limit (float) – Écrêtage limite. Valeur d’écrêtage (plus la valeur est élevée, plus le contraste est important). Flottant compris entre 0.0 et 1.0. Par défaut : 0.01.

Renvoie:

Nouvelle instance de EqualizeAdaptHistParam.

class cdl.param.EqualizeHistParam[source]

Paramètres d’égalisation d’histogramme

nbins

Nombre de classes. Nombre de classes de l’histogramme des niveaux de l’image. Entier supérieur à 1. Par défaut : 256.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(nbins: int) → cdl.computation.image.exposure.EqualizeHistParam

Renvoie une nouvelle instance de EqualizeHistParam avec les champs initialisés aux valeurs données.

Paramètres:: nbins (int) – Nombre de classes. Nombre de classes de l’histogramme des niveaux de l’image. Entier supérieur à 1. Par défaut : 256.
Renvoie:: Nouvelle instance de EqualizeHistParam.

class cdl.param.RescaleIntensityParam[source]

Paramètres de rééchelonnement d’intensité

in_range

Echelle de niveaux en entrée. Valeurs min/max d’intensité de l’image en entrée (“image” correspond aux niveaux min/max de l’image en entrée, “dtype” correspond aux valeurs min/max du type de données de l’image). Sélection unique parmi : “image”, “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “image”.

Type:: guidata.dataset.dataitems.ChoiceItem

out_range

Echelle de niveaux en sortie. Valeurs min/max d’intensité de l’image en sortie (“image” correspond aux niveaux min/max de l’image en entrée, “dtype” correspond aux valeurs min/max du type de données de l’image). Sélection unique parmi : “image”, “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(in_range: str, out_range: str) → cdl.computation.image.exposure.RescaleIntensityParam

Renvoie une nouvelle instance de RescaleIntensityParam avec les champs initialisés aux valeurs données.

Paramètres:

in_range (str) – Echelle de niveaux en entrée. Valeurs min/max d’intensité de l’image en entrée (“image” correspond aux niveaux min/max de l’image en entrée, “dtype” correspond aux valeurs min/max du type de données de l’image). Sélection unique parmi : “image”, “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “image”.
out_range (str) – Echelle de niveaux en sortie. Valeurs min/max d’intensité de l’image en sortie (“image” correspond aux niveaux min/max de l’image en entrée, “dtype” correspond aux valeurs min/max du type de données de l’image). Sélection unique parmi : “image”, “dtype”, “float32”, “float64”, “complex128”, “uint8”, “int16”, “uint16”, “int32”. Par défaut : “dtype”.

Renvoie:

Nouvelle instance de RescaleIntensityParam.

Paramètres morphologiques#

class cdl.param.MorphologyParam[source]

Paramètres de White Top-Hat

radius

Rayon. Rayon de l’ouverture circulaire (disque). Entier supérieur à 1. Par défaut : 1.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(radius: int) → cdl.computation.image.morphology.MorphologyParam

Renvoie une nouvelle instance de MorphologyParam avec les champs initialisés aux valeurs données.

Paramètres:: radius (int) – Rayon. Rayon de l’ouverture circulaire (disque). Entier supérieur à 1. Par défaut : 1.
Renvoie:: Nouvelle instance de MorphologyParam.

Paramètres de restauration#

class cdl.param.DenoiseBilateralParam[source]

Paramètres de débruitage par filtre bilatéral

sigma_spatial

σ_spatial. Ecart-type dans le domaine spatial. Une valeur élevée a pour effet de moyenner des pixels séparés par de grandes distances. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.

Type:: guidata.dataset.dataitems.FloatItem

mode

Sélection unique parmi : “constant”, “edge”, “symmetric”, “reflect”, “wrap”. Par défaut : “constant”.

Type:: guidata.dataset.dataitems.ChoiceItem

cval

Valeur de remplissage en dehors des bornes de l’image (en mode constant). Par défaut : 0.

Type:: guidata.dataset.dataitems.FloatItem

classmethod create(sigma_spatial: float, mode: str, cval: float) → cdl.computation.image.restoration.DenoiseBilateralParam

Renvoie une nouvelle instance de DenoiseBilateralParam avec les champs initialisés aux valeurs données.

Paramètres:

sigma_spatial (float) – σ_spatial. Ecart-type dans le domaine spatial. Une valeur élevée a pour effet de moyenner des pixels séparés par de grandes distances. Flottant supérieur à 0, non nul, unité : pixels. Par défaut : 1.0.
mode (str) – Sélection unique parmi : “constant”, “edge”, “symmetric”, “reflect”, “wrap”. Par défaut : “constant”.
cval (float) – Valeur de remplissage en dehors des bornes de l’image (en mode constant). Par défaut : 0.

Renvoie:

Nouvelle instance de DenoiseBilateralParam.

class cdl.param.DenoiseTVParam[source]

Paramètres de débruitage par variation totale

weight

Poids de débruitage. Plus le poids est élevé, plus le débruitage est fort (aux dépens de la fidélité des données). Flottant supérieur à 0, non nul. Par défaut : 0.1.

Type:: guidata.dataset.dataitems.FloatItem

eps

Epsilon. Différence relative de la valeur de la fonction de coût qui détermine le critère d’arrêt de l’algorithme. Ce dernier s’arrête lorsque : (e_(n-1) - e_n) < eps * e_0. Flottant supérieur à 0, non nul. Par défaut : 0.0002.

Type:: guidata.dataset.dataitems.FloatItem

max_num_iter

Nb. max. d’itérations. Nombre maximal d’itérations utilisé pour l’optimisation. Entier supérieur à 0, non nul. Par défaut : 200.

Type:: guidata.dataset.dataitems.IntItem

classmethod create(weight: float, eps: float, max_num_iter: int) → cdl.computation.image.restoration.DenoiseTVParam

Renvoie une nouvelle instance de DenoiseTVParam avec les champs initialisés aux valeurs données.

Paramètres:

weight (float) – Poids de débruitage. Plus le poids est élevé, plus le débruitage est fort (aux dépens de la fidélité des données). Flottant supérieur à 0, non nul. Par défaut : 0.1.
eps (float) – Epsilon. Différence relative de la valeur de la fonction de coût qui détermine le critère d’arrêt de l’algorithme. Ce dernier s’arrête lorsque : (e_(n-1) - e_n) < eps * e_0. Flottant supérieur à 0, non nul. Par défaut : 0.0002.
max_num_iter (int) – Nb. max. d’itérations. Nombre maximal d’itérations utilisé pour l’optimisation. Entier supérieur à 0, non nul. Par défaut : 200.

Renvoie:

Nouvelle instance de DenoiseTVParam.

class cdl.param.DenoiseWaveletParam[source]

Paramètres de débruitage par ondelettes

wavelet

Ondelette. Sélection unique parmi : “bior1.1”, “bior1.3”, “bior1.5”, “bior2.2”, “bior2.4”, “bior2.6”, “bior2.8”, “bior3.1”, “bior3.3”, “bior3.5”, “bior3.7”, “bior3.9”, “bior4.4”, “bior5.5”, “bior6.8”, “cgau1”, “cgau2”, “cgau3”, “cgau4”, “cgau5”, “cgau6”, “cgau7”, “cgau8”, “cmor”, “coif1”, “coif2”, “coif3”, “coif4”, “coif5”, “coif6”, “coif7”, “coif8”, “coif9”, “coif10”, “coif11”, “coif12”, “coif13”, “coif14”, “coif15”, “coif16”, “coif17”, “db1”, “db2”, “db3”, “db4”, “db5”, “db6”, “db7”, “db8”, “db9”, “db10”, “db11”, “db12”, “db13”, “db14”, “db15”, “db16”, “db17”, “db18”, “db19”, “db20”, “db21”, “db22”, “db23”, “db24”, “db25”, “db26”, “db27”, “db28”, “db29”, “db30”, “db31”, “db32”, “db33”, “db34”, “db35”, “db36”, “db37”, “db38”, “dmey”, “fbsp”, “gaus1”, “gaus2”, “gaus3”, “gaus4”, “gaus5”, “gaus6”, “gaus7”, “gaus8”, “haar”, “mexh”, “morl”, “rbio1.1”, “rbio1.3”, “rbio1.5”, “rbio2.2”, “rbio2.4”, “rbio2.6”, “rbio2.8”, “rbio3.1”, “rbio3.3”, “rbio3.5”, “rbio3.7”, “rbio3.9”, “rbio4.4”, “rbio5.5”, “rbio6.8”, “shan”, “sym2”, “sym3”, “sym4”, “sym5”, “sym6”, “sym7”, “sym8”, “sym9”, “sym10”, “sym11”, “sym12”, “sym13”, “sym14”, “sym15”, “sym16”, “sym17”, “sym18”, “sym19”, “sym20”. Par défaut : “sym9”.

Type:: guidata.dataset.dataitems.ChoiceItem

mode

Sélection unique parmi : “soft”, “hard”. Par défaut : “soft”.

Type:: guidata.dataset.dataitems.ChoiceItem

method

Méthode. Sélection unique parmi : “BayesShrink”, “VisuShrink”. Par défaut : “VisuShrink”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(wavelet: str, mode: str, method: str) → cdl.computation.image.restoration.DenoiseWaveletParam

Renvoie une nouvelle instance de DenoiseWaveletParam avec les champs initialisés aux valeurs données.

Paramètres:

wavelet (str) – Ondelette. Sélection unique parmi : “bior1.1”, “bior1.3”, “bior1.5”, “bior2.2”, “bior2.4”, “bior2.6”, “bior2.8”, “bior3.1”, “bior3.3”, “bior3.5”, “bior3.7”, “bior3.9”, “bior4.4”, “bior5.5”, “bior6.8”, “cgau1”, “cgau2”, “cgau3”, “cgau4”, “cgau5”, “cgau6”, “cgau7”, “cgau8”, “cmor”, “coif1”, “coif2”, “coif3”, “coif4”, “coif5”, “coif6”, “coif7”, “coif8”, “coif9”, “coif10”, “coif11”, “coif12”, “coif13”, “coif14”, “coif15”, “coif16”, “coif17”, “db1”, “db2”, “db3”, “db4”, “db5”, “db6”, “db7”, “db8”, “db9”, “db10”, “db11”, “db12”, “db13”, “db14”, “db15”, “db16”, “db17”, “db18”, “db19”, “db20”, “db21”, “db22”, “db23”, “db24”, “db25”, “db26”, “db27”, “db28”, “db29”, “db30”, “db31”, “db32”, “db33”, “db34”, “db35”, “db36”, “db37”, “db38”, “dmey”, “fbsp”, “gaus1”, “gaus2”, “gaus3”, “gaus4”, “gaus5”, “gaus6”, “gaus7”, “gaus8”, “haar”, “mexh”, “morl”, “rbio1.1”, “rbio1.3”, “rbio1.5”, “rbio2.2”, “rbio2.4”, “rbio2.6”, “rbio2.8”, “rbio3.1”, “rbio3.3”, “rbio3.5”, “rbio3.7”, “rbio3.9”, “rbio4.4”, “rbio5.5”, “rbio6.8”, “shan”, “sym2”, “sym3”, “sym4”, “sym5”, “sym6”, “sym7”, “sym8”, “sym9”, “sym10”, “sym11”, “sym12”, “sym13”, “sym14”, “sym15”, “sym16”, “sym17”, “sym18”, “sym19”, “sym20”. Par défaut : “sym9”.
mode (str) – Sélection unique parmi : “soft”, “hard”. Par défaut : “soft”.
method (str) – Méthode. Sélection unique parmi : “BayesShrink”, “VisuShrink”. Par défaut : “VisuShrink”.

Renvoie:

Nouvelle instance de DenoiseWaveletParam.

Paramètres de seuillage#

class cdl.param.ThresholdParam[source]

Paramètres de seuillage d’histogramme

method

Méthode de seuillage. Sélection unique parmi : “manual”, “isodata”, “li”, “mean”, “minimum”, “otsu”, “triangle”, “yen”. Par défaut : “manual”.

Type:: guidata.dataset.dataitems.ChoiceItem

bins

Nombre de classes. Entier supérieur à 1. Par défaut : 256.

Type:: guidata.dataset.dataitems.IntItem

value

Valeur de seuil. Par défaut : 0.0.

Type:: guidata.dataset.dataitems.FloatItem

operation

Opération. Sélection unique parmi : “>”, “<”. Par défaut : “>”.

Type:: guidata.dataset.dataitems.ChoiceItem

classmethod create(method: str, bins: int, value: float, operation: str) → cdl.computation.image.threshold.ThresholdParam

Renvoie une nouvelle instance de ThresholdParam avec les champs initialisés aux valeurs données.

Paramètres:

method (str) – Méthode de seuillage. Sélection unique parmi : “manual”, “isodata”, “li”, “mean”, “minimum”, “otsu”, “triangle”, “yen”. Par défaut : “manual”.
bins (int) – Nombre de classes. Entier supérieur à 1. Par défaut : 256.
value (float) – Valeur de seuil. Par défaut : 0.0.
operation (str) – Opération. Sélection unique parmi : “>”, “<”. Par défaut : “>”.

Renvoie:

Nouvelle instance de ThresholdParam.

Paramètres (cdl.param)#

Introduction aux jeux de données DataSet#

Paramètres communs#

Paramètres des signaux#

Paramètres des images#

Paramètres de base des images#

Paramètres de détection#

Paramètres de détection de contours#

Paramètres de correction d’exposition#

Paramètres morphologiques#

Paramètres de restauration#

Paramètres de seuillage#

Paramètres (`cdl.param`)#