pyspc.webservice.lamedo.bdimage.BdImage

class pyspc.webservice.lamedo.bdimage.BdImage(timeout=60)[source]

Bases : object

Structure du client accédant aux données de BdImage.

proxies

Dictionnaire des proxys {“protocol”: “proxy”}

Type:

None

client

Client de connexion à BdImage

Type:

libbdimage.bdiws.Client

filename

Nom du dernier fichier écrit

Type:

None, str

timeout

Délai maximal de réception des requêtes. Défault: 60

Type:

int

url

URL de la dernière requête

Type:

None, str

__init__(timeout=60)[source]

Initialise l’instance du webservice BdImage.

Paramètres:

timeout (int) – Délai maximal de réception des requêtes. Défault: 60

Methods

__init__([timeout])

Initialise l'instance du webservice BdImage.

check_client()

Contrôler si le client BdImage existe.

check_image(image)

Contrôler s'il s'agit bien d'une image BdImage.

check_precision(precision)

Contrôler si la précision est autorisée.

check_start([image, date])

Contrôler si la date respecte le premier instant de disponibilité.

check_stats(stats)

Contrôler si la stat est autorisée.

get([image, tdelta, first_dtime, ...])

Récupérer les données de la BdImage.

get_datatypes([asstr])

Lister des images.

get_precision()

Lister des précisions.

get_stats()

Lister des longueurs du retour des statistiques.

retrieve([dirname, domainname, image, ...])

Récupérer les données de la BdImage et les enregistrer dans des xml.

Attributes

client

Client BdImage.

webservices

Webservices BdImage.

check_client()[source]

Contrôler si le client BdImage existe.

Lève:

ValueError – Si le client est incorrect

classmethod check_image(image)[source]

Contrôler s’il s’agit bien d’une image BdImage.

Paramètres:

image (tuple) – Image BdImage (type, sous-type, bande)

Lève:

ValueError – Si l’image est incorrecte

check_precision(precision)[source]

Contrôler si la précision est autorisée.

Paramètres:

precision (str) – Qualité de la précision

Lève:

ValueError – Si la précision est incorrecte

check_start(image=None, date=None)[source]

Contrôler si la date respecte le premier instant de disponibilité.

Paramètres:
  • date (datetime.datetime) – Date à tester

  • image (tuple) – Tuple à 3 dimensions de l’identifiant de l’image (type Image, sous type Image, bande). Voir BdImage.get_datatypes() pour avoir la liste des images autorisées

Lève:

ValueError – Date est antérieure à la première date disponible de l’image

check_stats(stats)[source]

Contrôler si la stat est autorisée.

Paramètres:

stats (str) – Longueur du retour des statistiques.

Lève:

ValueError – Si la stat est incorrecte

property client

Client BdImage.

get(image=None, tdelta=None, first_dtime=None, last_dtime=None, runtime=None, domains=None, epsg='2154', stats=None, precision=None)[source]

Récupérer les données de la BdImage.

Paramètres:
  • image (tuple) – Tuple à 3 dimensions de l’identifiant de l’image (type Image, sous type Image, bande).

  • tdelta (str, timedelta, None) – Pas de temps de cumul de l’image

  • first_dtime (str, datetime, None) – Première date de la collection d’images

  • last_dtime (str, datetime, None) – Dernière date de la collection d’images

  • runtime (str, datetime, None) – Instant de production de la prévision. Utilisé uniquement si le type d’image est parmi BDIMAGE_FORECASTS

  • domains (str) – Chaine de caractères définissant les domaines

  • epsg (str) – Identifiant de la projection. Défaut: “2154” (Lambert 93)

  • stats (str) – Longueur du retour des statistiques.

  • precision (str) – Qualité de la précision.

Renvoie:

content – Dictionnaire des retours XML - clé: (domain, image, first_dtime, last_dtime, runtime, varname) - valeur: contenu de la réponse XML

Type renvoyé:

dict

classmethod get_datatypes(asstr=False)[source]

Lister des images.

Paramètres:

asstr (bool) – Renvoyer une liste de str (True) ou de tuples (False)

Renvoie:

images – Liste des images : (type, soustype, bande) ou type_soustype_bande

Type renvoyé:

list

classmethod get_precision()[source]

Lister des précisions.

classmethod get_stats()[source]

Lister des longueurs du retour des statistiques.

retrieve(dirname='.', domainname=None, image=None, tdelta=None, first_dtime=None, last_dtime=None, runtime=None, domains=None, epsg='2154', stats=None, precision=None)[source]

Récupérer les données de la BdImage et les enregistrer dans des xml.

Paramètres:
  • dirname (str) – Répertoire local d’archivage des fichiers XML de BdImage

  • domainname (str) – Nom des domaines géographiques. Si utilisé, le lieu est défini par domainname-domaintype

  • image (tuple) – Tuple à 3 dimensions de l’identifiant de l’image (type Image, sous type Image, bande).

  • tdelta (str, timedelta, None) – Pas de temps de cumul de l’image

  • first_dtime (str, datetime, None) – Première date de la collection d’images

  • last_dtime (str, datetime, None) – Dernière date de la collection d’images

  • runtime (str, datetime, None) – Instant de production de la prévision. Utilisé uniquement si le type d’image est parmi BDIMAGE_FORECASTS

  • domains (str) – Chaine de caractères définissant les domaines

  • epsg (str) – Identifiant de la projection. Défaut: “2154” (Lambert 93)

  • stats (str) – Longueur du retour des statistiques.

  • precision (str) – Qualité de la précision.

Renvoie:

filenames – Fichiers XML enregistrés

Type renvoyé:

list

property webservices

Webservices BdImage.