geopandas.GeoDataFrame

class geopandas.GeoDataFrame(*args, **kwargs)

A GeoDataFrame object is a pandas.DataFrame that has a column with geometry. In addition to the standard DataFrame constructor arguments, GeoDataFrame also accepts the following keyword arguments:

Parameters

crsvalue (optional)

Coordinate Reference System of the geometry objects. Can be anything accepted by pyproj.CRS.from_user_input(), such as an authority string (eg “EPSG:4326”) or a WKT string.

geometrystr or array (optional)

If str, column to use as geometry. If array, will be set as ‘geometry’ column on GeoDataFrame.

Examples

Constructing GeoDataFrame from a dictionary.

>>> from shapely.geometry import Point
>>> d = {'col1': ['name1', 'name2'], 'geometry': [Point(1,2), Point(2,1)]}
>>> gdf = gpd.GeoDataFrame(d, crs="EPSG:4326")
>>> gdf
    col1                 geometry
0  name1  POINT (1.00000 2.00000)
1  name2  POINT (2.00000 1.00000)

Notice that the inferred dtype of ‘geometry’ columns is geometry.

>>> gdf.dtypes
col1          object
geometry    geometry
dtype: object

__init__(self, *args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(self, \*args, \*\*kwargs)	Initialize self.
abs(self)	Return a Series/DataFrame with absolute numeric value of each element.
add(self, other[, axis, level, fill_value])	Get Addition of dataframe and other, element-wise (binary operator add).
add_prefix(self, prefix)	Prefix labels with string prefix.
add_suffix(self, suffix)	Suffix labels with string suffix.
affine_transform(self, matrix)	Return a GeoSeries with translated geometries.
agg(self, func[, axis])	Aggregate using one or more operations over the specified axis.
aggregate(self, func[, axis])	Aggregate using one or more operations over the specified axis.
align(self, other[, join, axis, level, …])	Align two objects on their axes with the specified join method.
all(self[, axis, bool_only, skipna, level])	Return whether all elements are True, potentially over an axis.
any(self[, axis, bool_only, skipna, level])	Return whether any element is True, potentially over an axis.
append(self, other[, ignore_index, …])	Append rows of other to the end of caller, returning a new object.
apply(self, func[, axis, raw, result_type, args])	Apply a function along an axis of the DataFrame.
applymap(self, func)	Apply a function to a Dataframe elementwise.
asfreq(self, freq[, method, fill_value])	Convert TimeSeries to specified frequency.
asof(self, where[, subset])	Return the last row(s) without any NaNs before where.
assign(self, \*\*kwargs)	Assign new columns to a DataFrame.
astype(self, dtype[, copy, errors])	Cast a pandas object to a specified dtype dtype.
at_time(self, time, asof[, axis])	Select values at particular time of day (e.g.
between_time(self, start_time, end_time, …)	Select values between particular times of the day (e.g., 9:00-9:30 AM).
bfill(self[, axis, limit, downcast])	Synonym for DataFrame.fillna() with method='bfill'.
bool(self)	Return the bool of a single element PandasObject.
boxplot(self[, column, by, ax, fontsize, …])	Make a box plot from DataFrame columns.
buffer(self, distance[, resolution])	Returns a GeoSeries of geometries representing all points within a given distance of each geometric object.
clip(self[, lower, upper, axis])	Trim values at input threshold(s).
combine(self, other, func[, fill_value, …])	Perform column-wise combine with another DataFrame.
combine_first(self, other)	Update null elements with value in the same location in other.
contains(self, other)	Returns a Series of dtype('bool') with value True for each geometry that contains other.
convert_dtypes(self, infer_objects, …)	Convert columns to best possible dtypes using dtypes supporting pd.NA.
copy(self, deep)	Make a copy of this object’s indices and data.
corr(self[, method, min_periods])	Compute pairwise correlation of columns, excluding NA/null values.
corrwith(self, other[, axis, drop, method])	Compute pairwise correlation.
count(self[, axis, level, numeric_only])	Count non-NA cells for each column or row.
cov(self[, min_periods])	Compute pairwise covariance of columns, excluding NA/null values.
covered_by(self, other)	Returns a Series of dtype('bool') with value True for each geometry that is entirely covered by other.
covers(self, other)	Returns a Series of dtype('bool') with value True for each geometry that is entirely covering other.
crosses(self, other)	Returns a Series of dtype('bool') with value True for each geometry that cross other.
cummax(self[, axis, skipna])	Return cumulative maximum over a DataFrame or Series axis.
cummin(self[, axis, skipna])	Return cumulative minimum over a DataFrame or Series axis.
cumprod(self[, axis, skipna])	Return cumulative product over a DataFrame or Series axis.
cumsum(self[, axis, skipna])	Return cumulative sum over a DataFrame or Series axis.
describe(self[, percentiles, include, exclude])	Generate descriptive statistics.
diff(self[, periods, axis])	First discrete difference of element.
difference(self, other)	Returns a GeoSeries of the points in each geometry that are not in other.
disjoint(self, other)	Returns a Series of dtype('bool') with value True for each geometry disjoint to other.
dissolve(self[, by, aggfunc, as_index])	Dissolve geometries within groupby into single observation.
distance(self, other)	Returns a Series containing the distance to other.
div(self, other[, axis, level, fill_value])	Get Floating division of dataframe and other, element-wise (binary operator truediv).
divide(self, other[, axis, level, fill_value])	Get Floating division of dataframe and other, element-wise (binary operator truediv).
dot(self, other)	Compute the matrix multiplication between the DataFrame and other.
drop(self[, labels, axis, index, columns, …])	Drop specified labels from rows or columns.
drop_duplicates(self, subset, …)	Return DataFrame with duplicate rows removed.
droplevel(self, level[, axis])	Return DataFrame with requested index / column level(s) removed.
dropna(self[, axis, how, thresh, subset, …])	Remove missing values.
duplicated(self, subset, Sequence[Hashable], …)	Return boolean Series denoting duplicate rows.
eq(self, other[, axis, level])	Get Equal to of dataframe and other, element-wise (binary operator eq).
equals(self, other)	Test whether two objects contain the same elements.
eval(self, expr[, inplace])	Evaluate a string describing operations on DataFrame columns.
ewm(self[, com, span, halflife, alpha, …])	Provide exponential weighted functions.
expanding(self[, min_periods, center, axis])	Provide expanding transformations.
explode(self)	Explode muti-part geometries into multiple single geometries.
ffill(self[, axis, limit, downcast])	Synonym for DataFrame.fillna() with method='ffill'.
fillna(self[, value, method, axis, inplace, …])	Fill NA/NaN values using the specified method.
filter(self[, items, axis])	Subset the dataframe rows or columns according to the specified index labels.
first(self, offset)	Method to subset initial periods of time series data based on a date offset.
first_valid_index(self)	Return index for first non-NA/null value.
floordiv(self, other[, axis, level, fill_value])	Get Integer division of dataframe and other, element-wise (binary operator floordiv).
from_dict(data[, orient, dtype, columns])	Construct DataFrame from dict of array-like or dicts.
from_features(features[, crs, columns])	Alternate constructor to create GeoDataFrame from an iterable of features or a feature collection.
from_file(filename, \*\*kwargs)	Alternate constructor to create a GeoDataFrame from a file.
from_postgis(sql, con[, geom_col, crs, …])	Alternate constructor to create a GeoDataFrame from a sql query containing a geometry column in WKB representation.
from_records(data[, index, exclude, …])	Convert structured or record ndarray to DataFrame.
ge(self, other[, axis, level])	Get Greater than or equal to of dataframe and other, element-wise (binary operator ge).
geom_almost_equals(self, other[, decimal])	Returns a Series of dtype('bool') with value True if each geometry is approximately equal to other.
geom_equals(self, other)	Returns a Series of dtype('bool') with value True for each geometry equal to other.
geom_equals_exact(self, other, tolerance)	Return True for all geometries that equal other to a given tolerance, else False
get(self, key[, default])	Get item from object for given key (ex: DataFrame column).
groupby(self[, by, axis, level])	Group DataFrame using a mapper or by a Series of columns.
gt(self, other[, axis, level])	Get Greater than of dataframe and other, element-wise (binary operator gt).
head(self, n)	Return the first n rows.
hist(data[, column, by, grid, xlabelsize, …])	Make a histogram of the DataFrame’s.
idxmax(self[, axis, skipna])	Return index of first occurrence of maximum over requested axis.
idxmin(self[, axis, skipna])	Return index of first occurrence of minimum over requested axis.
infer_objects(self)	Attempt to infer better dtypes for object columns.
info(self[, verbose, buf, max_cols, …])	Print a concise summary of a DataFrame.
insert(self, loc, column, value[, …])	Insert column into DataFrame at specified location.
interpolate(self, distance[, normalized])	Return a point at the specified distance along each geometry
intersection(self, other)	Returns a GeoSeries of the intersection of points in each geometry with other.
intersects(self, other)	Returns a Series of dtype('bool') with value True for each geometry that intersects other.
isin(self, values)	Whether each element in the DataFrame is contained in values.
isna(self)	Detect missing values.
isnull(self)	Detect missing values.
items(self)	Iterate over (column name, Series) pairs.
iterfeatures(self[, na, show_bbox])	Returns an iterator that yields feature dictionaries that comply with __geo_interface__
iteritems(self)	Iterate over (column name, Series) pairs.
iterrows(self)	Iterate over DataFrame rows as (index, Series) pairs.
itertuples(self[, index, name])	Iterate over DataFrame rows as namedtuples.
join(self, other[, on, how, lsuffix, …])	Join columns of another DataFrame.
keys(self)	Get the ‘info axis’ (see Indexing for more).
kurt(self[, axis, skipna, level, numeric_only])	Return unbiased kurtosis over requested axis.
kurtosis(self[, axis, skipna, level, …])	Return unbiased kurtosis over requested axis.
last(self, offset)	Method to subset final periods of time series data based on a date offset.
last_valid_index(self)	Return index for last non-NA/null value.
le(self, other[, axis, level])	Get Less than or equal to of dataframe and other, element-wise (binary operator le).
lookup(self, row_labels, col_labels)	Label-based “fancy indexing” function for DataFrame.
lt(self, other[, axis, level])	Get Less than of dataframe and other, element-wise (binary operator lt).
mad(self[, axis, skipna, level])	Return the mean absolute deviation of the values for the requested axis.
mask(self, cond[, other, inplace, axis, …])	Replace values where the condition is True.
max(self[, axis, skipna, level, numeric_only])	Return the maximum of the values for the requested axis.
mean(self[, axis, skipna, level, numeric_only])	Return the mean of the values for the requested axis.
median(self[, axis, skipna, level, numeric_only])	Return the median of the values for the requested axis.
melt(self[, id_vars, value_vars, var_name, …])	Unpivot a DataFrame from wide to long format, optionally leaving identifiers set.
memory_usage(self[, index, deep])	Return the memory usage of each column in bytes.
merge(self, \*args, \*\*kwargs)	Merge two GeoDataFrame objects with a database-style join.
min(self[, axis, skipna, level, numeric_only])	Return the minimum of the values for the requested axis.
mod(self, other[, axis, level, fill_value])	Get Modulo of dataframe and other, element-wise (binary operator mod).
mode(self[, axis, numeric_only, dropna])	Get the mode(s) of each element along the selected axis.
mul(self, other[, axis, level, fill_value])	Get Multiplication of dataframe and other, element-wise (binary operator mul).
multiply(self, other[, axis, level, fill_value])	Get Multiplication of dataframe and other, element-wise (binary operator mul).
ne(self, other[, axis, level])	Get Not equal to of dataframe and other, element-wise (binary operator ne).
nlargest(self, n, columns[, keep])	Return the first n rows ordered by columns in descending order.
notna(self)	Detect existing (non-missing) values.
notnull(self)	Detect existing (non-missing) values.
nsmallest(self, n, columns[, keep])	Return the first n rows ordered by columns in ascending order.
nunique(self[, axis, dropna])	Count distinct observations over requested axis.
overlaps(self, other)	Returns True for all geometries that overlap other, else False.
pct_change(self[, periods, fill_method, …])	Percentage change between the current and a prior element.
pipe(self, func, \*args, \*\*kwargs)	Apply func(self, *args, **kwargs).
pivot(self[, index, columns, values])	Return reshaped DataFrame organized by given index / column values.
pivot_table(self[, values, index, columns, …])	Create a spreadsheet-style pivot table as a DataFrame.
plot(self, \*args, \*\*kwargs)	Plot a GeoDataFrame.
pop(self, item)	Return item and drop from frame.
pow(self, other[, axis, level, fill_value])	Get Exponential power of dataframe and other, element-wise (binary operator pow).
prod(self[, axis, skipna, level, …])	Return the product of the values for the requested axis.
product(self[, axis, skipna, level, …])	Return the product of the values for the requested axis.
project(self, other[, normalized])	Return the distance along each geometry nearest to other
quantile(self[, q, axis, numeric_only, …])	Return values at the given quantile over requested axis.
query(self, expr[, inplace])	Query the columns of a DataFrame with a boolean expression.
radd(self, other[, axis, level, fill_value])	Get Addition of dataframe and other, element-wise (binary operator radd).
rank(self[, axis])	Compute numerical data ranks (1 through n) along axis.
rdiv(self, other[, axis, level, fill_value])	Get Floating division of dataframe and other, element-wise (binary operator rtruediv).
reindex(self[, labels, index, columns, …])	Conform DataFrame to new index with optional filling logic.
reindex_like(self, other, method, …[, …])	Return an object with matching indices as other object.
relate(self, other)	Returns the DE-9IM intersection matrices for the geometries
rename(self[, mapper, index, columns, axis, …])	Alter axes labels.
rename_axis(self[, mapper, index, columns, …])	Set the name of the axis for the index or columns.
rename_geometry(self, col[, inplace])	Renames the GeoDataFrame geometry column to the specified name.
reorder_levels(self, order[, axis])	Rearrange index levels using input order.
replace(self[, to_replace, value, inplace, …])	Replace values given in to_replace with value.
representative_point(self)	Returns a GeoSeries of (cheaply computed) points that are guaranteed to be within each geometry.
resample(self, rule[, axis, loffset, on, level])	Resample time-series data.
reset_index(self, level, Sequence[Hashable], …)	Reset the index, or a level of it.
rfloordiv(self, other[, axis, level, fill_value])	Get Integer division of dataframe and other, element-wise (binary operator rfloordiv).
rmod(self, other[, axis, level, fill_value])	Get Modulo of dataframe and other, element-wise (binary operator rmod).
rmul(self, other[, axis, level, fill_value])	Get Multiplication of dataframe and other, element-wise (binary operator rmul).
rolling(self, window[, min_periods, center, …])	Provide rolling window calculations.
rotate(self, angle[, origin, use_radians])	Returns a GeoSeries with rotated geometries.
round(self[, decimals])	Round a DataFrame to a variable number of decimal places.
rpow(self, other[, axis, level, fill_value])	Get Exponential power of dataframe and other, element-wise (binary operator rpow).
rsub(self, other[, axis, level, fill_value])	Get Subtraction of dataframe and other, element-wise (binary operator rsub).
rtruediv(self, other[, axis, level, fill_value])	Get Floating division of dataframe and other, element-wise (binary operator rtruediv).
sample(self[, n, frac, replace, weights, …])	Return a random sample of items from an axis of object.
scale(self[, xfact, yfact, zfact, origin])	Returns a GeoSeries with scaled geometries.
select_dtypes(self[, include, exclude])	Return a subset of the DataFrame’s columns based on the column dtypes.
sem(self[, axis, skipna, level, ddof, …])	Return unbiased standard error of the mean over requested axis.
set_axis(self, labels[, axis, inplace])	Assign desired index to given axis.
set_crs(self[, crs, epsg, inplace, …])	Set the Coordinate Reference System (CRS) of the GeoDataFrame.
set_geometry(self, col[, drop, inplace, crs])	Set the GeoDataFrame geometry using either an existing column or the specified input.
set_index(self, keys[, drop, append, …])	Set the DataFrame index using existing columns.
shift(self[, periods, freq, axis, fill_value])	Shift index by desired number of periods with an optional time freq.
simplify(self, \*args, \*\*kwargs)	Returns a GeoSeries containing a simplified representation of each geometry.
skew(self[, xs, ys, origin, use_radians])	Returns a GeoSeries with skewed geometries.
slice_shift(self, periods[, axis])	Equivalent to shift without copying data.
sort_index(self[, axis, level, ascending, …])	Sort object by labels (along an axis).
sort_values(self, by[, axis, ascending, …])	Sort by the values along either axis.
squeeze(self[, axis])	Squeeze 1 dimensional axis objects into scalars.
stack(self[, level, dropna])	Stack the prescribed level(s) from columns to index.
std(self[, axis, skipna, level, ddof, …])	Return sample standard deviation over requested axis.
sub(self, other[, axis, level, fill_value])	Get Subtraction of dataframe and other, element-wise (binary operator sub).
subtract(self, other[, axis, level, fill_value])	Get Subtraction of dataframe and other, element-wise (binary operator sub).
sum(self[, axis, skipna, level, …])	Return the sum of the values for the requested axis.
swapaxes(self, axis1, axis2[, copy])	Interchange axes and swap values axes appropriately.
swaplevel(self[, i, j, axis])	Swap levels i and j in a MultiIndex on a particular axis.
symmetric_difference(self, other)	Returns a GeoSeries of the symmetric difference of points in each geometry with other.
tail(self, n)	Return the last n rows.
take(self, indices[, axis])	Return the elements in the given positional indices along an axis.
to_clipboard(self, excel, sep, …)	Copy object to the system clipboard.
to_crs(self[, crs, epsg, inplace])	Transform geometries to a new coordinate reference system.
to_csv(self, path_or_buf, pathlib.Path, …)	Write object to a comma-separated values (csv) file.
to_dict(self[, orient, into])	Convert the DataFrame to a dictionary.
to_excel(self, excel_writer[, sheet_name, …])	Write object to an Excel sheet.
to_feather(self, path[, index, compression])	Write a GeoDataFrame to the Feather format.
to_file(self, filename[, driver, schema, index])	Write the GeoDataFrame to a file.
to_gbq(self, destination_table[, …])	Write a DataFrame to a Google BigQuery table.
to_hdf(self, path_or_buf, key, mode, …[, …])	Write the contained data to an HDF5 file using HDFStore.
to_html(self[, buf, columns, col_space, …])	Render a DataFrame as an HTML table.
to_json(self[, na, show_bbox])	Returns a GeoJSON representation of the GeoDataFrame as a string.
to_latex(self[, buf, columns, col_space, …])	Render object to a LaTeX tabular, longtable, or nested table/tabular.
to_markdown(self, buf, NoneType] = None, …)	Print DataFrame in Markdown-friendly format.
to_numpy(self[, dtype, copy])	Convert the DataFrame to a NumPy array.
to_parquet(self, path[, index, compression])	Write a GeoDataFrame to the Parquet format.
to_period(self[, freq, axis, copy])	Convert DataFrame from DatetimeIndex to PeriodIndex.
to_pickle(self, path, compression, …)	Pickle (serialize) object to file.
to_postgis(self, name, con[, schema, …])	Upload GeoDataFrame into PostGIS database.
to_records(self[, index, column_dtypes, …])	Convert DataFrame to a NumPy record array.
to_sql(self, name, con[, schema, …])	Write records stored in a DataFrame to a SQL database.
to_stata(self, path[, convert_dates, …])	Export DataFrame object to Stata dta format.
to_string(self, buf, pathlib.Path, IO[str], …)	Render a DataFrame to a console-friendly tabular output.
to_timestamp(self[, freq, how, axis, copy])	Cast to DatetimeIndex of timestamps, at beginning of period.
to_xarray(self)	Return an xarray object from the pandas object.
touches(self, other)	Returns a Series of dtype('bool') with value True for each geometry that touches other.
transform(self, func[, axis])	Call func on self producing a DataFrame with transformed values.
translate(self[, xoff, yoff, zoff])	Returns a GeoSeries with translated geometries.
transpose(self, \*args, copy)	Transpose index and columns.
truediv(self, other[, axis, level, fill_value])	Get Floating division of dataframe and other, element-wise (binary operator truediv).
truncate(self[, before, after, axis])	Truncate a Series or DataFrame before and after some index value.
tshift(self, periods[, freq, axis])	Shift the time index, using the index’s frequency if available.
tz_convert(self, tz[, axis, level])	Convert tz-aware axis to target time zone.
tz_localize(self, tz[, axis, level, ambiguous])	Localize tz-naive index of a Series or DataFrame to target time zone.
union(self, other)	Returns a GeoSeries of the union of points in each geometry with other.
unstack(self[, level, fill_value])	Pivot a level of the (necessarily hierarchical) index labels.
update(self, other[, join, overwrite, …])	Modify in place using non-NA values from another DataFrame.
var(self[, axis, skipna, level, ddof, …])	Return unbiased variance over requested axis.
where(self, cond[, other, inplace, axis, …])	Replace values where the condition is False.
within(self, other)	Returns a Series of dtype('bool') with value True for each geometry that is within other.
xs(self, key[, axis, level])	Return cross-section from the Series/DataFrame.

Attributes

T	Transpose index and columns.
area	Returns a Series containing the area of each geometry in the GeoSeries.
at	Access a single value for a row/column label pair.
attrs	Dictionary of global attributes on this object.
axes	Return a list representing the axes of the DataFrame.
boundary	Returns a GeoSeries of lower dimensional objects representing each geometries’s set-theoretic boundary.
bounds	Returns a DataFrame with columns minx, miny, maxx, maxy values containing the bounds for each geometry.
cascaded_union	Deprecated: Return the unary_union of all geometries
centroid	Returns a GeoSeries of points representing the centroid of each geometry.
columns	The column labels of the DataFrame.
convex_hull	Returns a GeoSeries of geometries representing the convex hull of each geometry.
crs	The Coordinate Reference System (CRS) represented as a pyproj.CRS object.
cx	Coordinate based indexer to select by intersection with bounding box.
dtypes	Return the dtypes in the DataFrame.
empty	Indicator whether DataFrame is empty.
envelope	Returns a GeoSeries of geometries representing the envelope of each geometry.
exterior	Returns a GeoSeries of LinearRings representing the outer boundary of each polygon in the GeoSeries.
geom_type	Returns a Series of strings specifying the Geometry Type of each object.
geometry	Geometry data for GeoDataFrame
has_z	Returns a Series of dtype('bool') with value True for features that have a z-component.
iat	Access a single value for a row/column pair by integer position.
iloc	Purely integer-location based indexing for selection by position.
index	The index (row labels) of the DataFrame.
interiors	Returns a Series of List representing the inner rings of each polygon in the GeoSeries.
is_empty	Returns a Series of dtype('bool') with value True for empty geometries.
is_ring	Returns a Series of dtype('bool') with value True for features that are closed.
is_simple	Returns a Series of dtype('bool') with value True for geometries that do not cross themselves.
is_valid	Returns a Series of dtype('bool') with value True for geometries that are valid.
length	Returns a Series containing the length of each geometry.
loc	Access a group of rows and columns by label(s) or a boolean array.
ndim	Return an int representing the number of axes / array dimensions.
shape	Return a tuple representing the dimensionality of the DataFrame.
sindex
size	Return an int representing the number of elements in this object.
style	Returns a Styler object.
total_bounds	Returns a tuple containing minx, miny, maxx, maxy values for the bounds of the series as a whole.
type	Return the geometry type of each geometry in the GeoSeries
unary_union	Returns a geometry containing the union of all geometries in the GeoSeries.
values	Return a Numpy representation of the DataFrame.

GeoDataFrame geopandas.GeoDataFrame.from_file