cartoreader_lite.low_level.study#

Classes

CartoAuxMesh(xml_h, path_prefix[, load])

Class that holds auxiliary meshes of the CARTO system, e.g.

CartoLLMap(xml_h, path_prefix)

Low level CARTO3 map container for all point associated data.

CartoLLStudy(arg1[, arg2])

Low level CARTO study class that reads all information found in the CARTO3 study and saves it.

class cartoreader_lite.low_level.study.CartoLLMap(xml_h: xml.etree.ElementTree.Element, path_prefix: str)#

Low level CARTO3 map container for all point associated data.

Parameters
  • xml_h (Element) – XML element holding the map data

  • path_prefix (str) – Prefix of the path to load from

import_raw_points(path_prefix: str)#

Imports all points and its detailed data of the current map

Parameters

path_prefix (str) – Prefix of the path to load from

class cartoreader_lite.low_level.study.CartoAuxMesh(xml_h: xml.etree.ElementTree.Element, path_prefix: str, load=True)#

Class that holds auxiliary meshes of the CARTO system, e.g. generated by CartoSeg.

Parameters
  • xml_h (Element) – XML entry point from where to read the auxiliary meshes

  • path_prefix (str) – Path prefix pointing to the directory to read from

  • load (bool, optional) – If true, the meshes will be read and buffered immediately. If false, only the names will be loaded and load_mesh() will need to be called later. By default True

mesh_data: pyvista.core.pointset.UnstructuredGrid#

The loaded mesh

metadata: Dict[str, str]#

Metadata associated with the mesh, given by the XML tags

affine: numpy.ndarray#

4x4 affine transformation matrix given by CARTO

mesh_path: str#

Full path to the mesh file

name: str#

Name of the mesh

load_mesh()#

Loads the mesh with the given name into the memory

class cartoreader_lite.low_level.study.CartoLLStudy(arg1: str, arg2: Optional[str] = None)#

Low level CARTO study class that reads all information found in the CARTO3 study and saves it.

Parameters
  • arg1 (str) –

    A path to either

    • A directory containing the study

    • A zip file with the study inside

  • arg2 (str, optional) – The name of the study to load, contained inside the directory or zip file. Will default to either the zip name or bottom most directory name.