geofileops.export_by_location

geofileops.export_by_location(input_to_select_from_path: Union[str, os.PathLike[Any]], input_to_compare_with_path: Union[str, os.PathLike[Any]], output_path: Union[str, os.PathLike[Any]], min_area_intersect: Optional[float] = None, area_inters_column_name: Optional[str] = None, input1_layer: Optional[str] = None, input1_columns: Optional[List[str]] = None, input2_layer: Optional[str] = None, output_layer: Optional[str] = None, gridsize: float = 0.0, where_post: Optional[str] = None, nb_parallel: int = -1, batchsize: int = -1, force: bool = False)

Exports all intersecting features.

All features in input_to_select_from_path that intersect with any features in input_to_compare_with_path are exported.

Alternative names:

• QGIS: extract by location

Parameters:

• input_to_select_from_path (PathLike) – the 1st input file

• input_to_compare_with_path (PathLike) – the 2nd input file

• output_path (PathLike) – the file to write the result to

• min_area_intersect (float, optional) – minimum area of the intersection. Defaults to None.

• area_inters_column_name (str, optional) – column name of the intersect area. If None, no area column is added. Defaults to None.

• input1_layer (str, optional) – input layer name. Optional if the file only contains one layer.

• input1_columns (List[str], optional) – list of columns to retain. If None, all standard columns are retained. In addition to standard columns, it is also possible to specify “fid”, a unique index available in all input files. Note that the “fid” will be aliased eg. to “fid_1”. Defaults to None.

• input2_layer (str, optional) – input layer name. Optional if the file only contains one layer.

• input2_columns (List[str], optional) – NA.

• output_layer (str, optional) – output layer name. Optional if the file only contains one layer.

• gridsize (float, optional) – the size of the grid the coordinates of the ouput will be rounded to. Eg. 0.001 to keep 3 decimals. Value 0.0 doesn’t change the precision. Defaults to 0.0.

• where_post (str, optional) – SQL filter to apply after all other processing, including e.g. explodecollections. It should be in sqlite syntax and spatialite reference functions can be used. Defaults to None.

• nb_parallel (int, optional) – the number of parallel processes to use. Defaults to -1: use all available CPUs.

• batchsize (int, optional) – indicative number of rows to process per batch. A smaller batch size, possibly in combination with a smaller nb_parallel, will reduce the memory usage. Defaults to -1: (try to) determine optimal size automatically.

• force (bool, optional) – overwrite existing output file(s). Defaults to False.