Query Results#

This module defines classes that store the results of queries. It includes:

Type of Query Result	Description
`QueryResult`	A combined result of the `PointsResult`, `BBoxesResult`, and `PolygonsResult` queries. This class is the default return type of the geospatial Queries results for the datasets.
`BaseResult`	Base class for the result of the queries.
`PointsResult`	A class to manage the result of `Points` query.
`BBoxesResult`	A class to manage the result of `BoundingBox` query.
`PolygonsResult`	A class to manage the result of `Polygons` query.

Base Result#

class faninsar.query.result.BaseResult(result)#

Bases: object

Base class for the result of the queries.

__init__(result)#

property data: list[ndarray] | None#: List of numpy arrays.

property dims: str | None#: Description of the dimensions.

property frame: DataFrame | None#: DataFrame of the result.

property is_empty: bool#: if the result is empty.

Points Result#

class faninsar.query.result.PointsResult(result)#

Bases: BaseResult

A class to manage the result of Points query.

__init__(result)#

property data: list[ndarray] | None#: List of numpy arrays.

property dims: str | None#: Description of the dimensions.

property frame: DataFrame | None#: DataFrame of the result.

property is_empty: bool#: if the result is empty.

BBoxes Result#

class faninsar.query.result.BBoxesResult(result)#

Bases: BaseResult

A class to manage the result of BoundingBox query.

property transforms: list[Affine] | None#

__init__(result)#

property data: list[ndarray] | None#: List of numpy arrays.

property dims: str | None#: Description of the dimensions.

property frame: DataFrame | None#: DataFrame of the result.

property is_empty: bool#: if the result is empty.

Polygons Result#

class faninsar.query.result.PolygonsResult(result)#

Bases: BBoxesResult

A class to manage the result of Polygons query.

property transforms: list[Affine] | None#

property masks: list[ndarray] | None#

__init__(result)#

property data: list[ndarray] | None#: List of numpy arrays.

property dims: str | None#: Description of the dimensions.

property frame: DataFrame | None#: DataFrame of the result.

property is_empty: bool#: if the result is empty.

Query Result#

class faninsar.query.result.QueryResult(points=None, boxes=None, polygons=None, query=None)#