Слой#
- class integro.Layer2D(layer)#
Двумерный слой.
- add_data(data: DataFrame, schema: Dict | None = None, overwrite: bool = False) bool#
Добавить новые поля к данным слоя.
- Parameters:
data (pd.DataFrame) – Данные для добавления.
schema (dict, optional) – Описание структуры полей. Если не задано, определяется из добавляемых данных.
overwrite (bool, default=False) – Перезаписывать ли поле если оно уже существует.
- Returns:
True если поля были добавлены или False в случае ошибки.
- Return type:
bool
- add_grid(vals: ndarray, field: str, alias: str | None = None, overwrite: bool = False) bool#
Добавить двумерную сеть к данным слоя.
- Parameters:
vals (np.ndarray of shape (ny, nx)) – Данные двумерной сети.
field (str) – Имя добавляемой сети.
alias (str or None, optional) – Название добавляемой сети, если не задано совпадает с именем.
overwrite (bool, default=False) – Перезаписывать ли сеть если она уже существует.
- Returns:
True если сеть была добавлена или False в случае ошибки.
- Return type:
bool
- load_data(fields: List[str | int] | None = None, geom: str | None = '') DataFrame | None#
Загрузить данные слоя в pd.Dataframe.
- Parameters:
fields (list of (str or int), optional) – Список загружаемых полей, можно указать имена полей или их индексы. Если не задано будут загружены все доступные поля.
geom (str or None, optional) – Название колонки с геометрией. Если передать None, геометрия не будет загружена. Если не задано используется название ‘geometry’.
- Returns:
Данные слоя или None в случае ошибки.
- Return type:
pd.Dataframe or None
- load_grid(field: str | None = None) ndarray | None#
Загрузить двумерную сеть в np.ndarray. Доступно только для слоев типа Layer2DType.TOS_GRID или Layer2DType.GRID.
- Parameters:
field (str, optional) – Имя загружаемого поля, если не задано используется поле стилевого оформления слоя.
- Returns:
Двумерная сеть или None в случае ошибки.
- Return type:
np.ndarray or None
- property caption: str#
Название слоя.
- property crs: str#
Система координат слоя (строка PROJ4).
- property extent: Rect2D#
Экстент слоя.
- property fields: List[str] | None#
Список доступных полей.
- property marked: bool#
Выбран слой или нет.
- property mtype: str#
Тип слоя, одно из значений
Layer2DType.
- property selectable: bool#
Возможность выбора объектов слоя.
- property source: str#
Источник данных слоя. Файл, папка или строка подключения.
- property style_field: str#
Имя поля стилевого оформления.
- property visible: bool#
Отображать слой или нет.
- class integro.Layer3D(layer)#
Трехмерный слой.
- add_data(data: DataFrame, schema: Dict | None = None, overwrite: bool = False) bool#
Добавить новые поля к данным слоя.
- Parameters:
data (pd.DataFrame) – Данные для добавления.
schema (dict, optional) – Описание структуры полей. Если не задано, определяется из добавляемых данных.
overwrite (bool, default=False) – Перезаписывать ли поле если оно уже существует.
- Returns:
True если поля были добавлены или False в случае ошибки.
- Return type:
bool
- add_grid(vals: ndarray, field: str, alias: str | None = None, overwrite: bool = False) bool#
Добавить двумерную сеть к данным слоя.
- Parameters:
vals (np.ndarray of shape (ny, nx)) – Данные двумерной сети.
field (str) – Имя добавляемой сети.
alias (str or None, optional) – Название добавляемой сети, если не задано совпадает с именем.
overwrite (bool, default=False) – Перезаписывать ли сеть если она уже существует.
- Returns:
True если сеть была добавлена или False в случае ошибки.
- Return type:
bool
- load_data(fields: List[str | int] | None = None, geom: str | None = '') DataFrame | None#
Загрузить данные слоя в pd.Dataframe.
- Parameters:
fields (list of (str or int), optional) – Список загружаемых полей, можно указать имена полей или их индексы. Если не задано будут загружены все доступные поля.
geom (str or None, optional) – Название колонки с геометрией. Если передать None, геометрия не будет загружена. Если не задано используется название ‘geometry’.
- Returns:
Данные слоя или None в случае ошибки.
- Return type:
pd.Dataframe or None
- load_grid(field: str | None = None) ndarray | None#
Загрузить двумерную сеть в np.ndarray. Доступно только для слоев типа Layer2DType.TOS_GRID или Layer2DType.GRID.
- Parameters:
field (str, optional) – Имя загружаемого поля, если не задано используется поле стилевого оформления слоя.
- Returns:
Двумерная сеть или None в случае ошибки.
- Return type:
np.ndarray or None
- property caption: str#
Название слоя.
- property crs: str#
Система координат слоя (строка PROJ4).
- property extent: Rect3D#
Экстент слоя.
- property fields: List[str] | None#
Список доступных полей.
- property marked: bool#
Выбран слой или нет.
- property mtype: str#
Тип слоя, одно из значений
Layer3DType.
- property selectable: bool#
Возможность выбора объектов слоя.
- property source: str#
Источник данных слоя. Файл, папка или строка подключения.
- property style_field: str#
Имя поля стилевого оформления.
- property visible: bool#
Отображать слой или нет.
- class integro.LayoutLayer(layer)#
Слой макета.
- property caption: str#
Название слоя.
- property extent: Rect2D#
Экстент слоя.
- property marked: bool#
Выбран слой или нет.
- property mtype: str#
Тип слоя, одно из значений
LayoutType.
- property selectable: bool#
Возможность выбора объектов слоя.
- property source: str#
Источник данных слоя. Файл, папка или строка подключения.
- property visible: bool#
Отображать слой или нет.
- class integro.Layer2DType(value)#
Тип двумерного слоя.
- class integro.Layer3DType(value)#
Тип трехмерного слоя.
- class integro.LayoutType(value)#
Тип слоя макета.