arcgis.features module¶

The arcgis.features module contains types and functions for working with features and feature layers in the GIS.

Entities located in space with a geometrical representation (such as points, lines or polygons) and a set of properties can be represented as features. The arcgis.features module is used for working with feature data, feature layers and collections of feature layers in the GIS. It also contains the spatial analysis functions which operate against feature data.

In the GIS, entities located in space with a set of properties can be represented as features. Features are stored as feature classes, which represent a set of features located using a single spatial type (point, line, polygon) and a common set of properties. This is the geographic extension of the classic tabular or relational representation for entities - a set of entities is modelled as rows in a table. Tables represent entity classes with uniform properties. In addition to working with entities with location as features, the system can also work with non-spatial entities as rows in tables. The system can also model relationships between entities using properties which act as primary and foreign keys. A collection of feature classes and tables, with the associated relationships among the entities, is a feature layer collection. FeatureLayerCollections are one of the dataset types contained in a Datastore. Finally, features are not simply entities in a dataset. Features have a visual representation and user experience - on a map, in a 3D scene, as entities with a property sheet or popups.

arcgis.features.Feature¶

class arcgis.features.Feature(geometry=None, attributes=None)¶

Entities located in space with a set of properties can be represented as features.

as_dict¶: returns the feature as a dictionary

as_row¶: converts a feature to a list for insertion into an insert cursor Output:

[row items], [field names] returns a list of fields and the row object

attributes¶: returns the feature attributes

fields¶: returns a list of feature fields

classmethod from_dict(feature)¶: returns a feature from a dict

classmethod from_json(json_str)¶: returns a feature from a JSON string

geometry¶: returns the feature geometry

geometry_type¶: returns the feature’s geometry type

get_value(field_name)¶: returns a value for a given field name

set_value(field_name, value)¶: sets an attribute value for a given field name

arcgis.features.FeatureLayer¶

class arcgis.features.FeatureLayer(url, gis=None, container=None)¶

The feature layer is the primary concept for working with features in a GIS.

Users create, import, export, analyze, edit, and visualize features, i.e. entities in space as feature layers.

Feature layers can be added to and visualized using maps. They act as inputs to and outputs from feature analysis tools.

Feature layers are created by publishing feature data to a GIS, and are exposed as a broader resource (Item) in the GIS. Feature layer objects can be obtained through the layers attribute on feature layer Items in the GIS.

calculate(where, calc_expression, sql_format='standard')¶

The calculate operation is performed on a feature layer resource. It updates the values of one or more fields in an existing feature service layer based on SQL expressions or scalar values. The calculate operation can only be used if the supportsCalculate property of the layer is true. Neither the Shape field nor system fields can be updated using calculate. System fields include ObjectId and GlobalId. See Calculate a field for more information on supported expressions

Inputs:

where - A where clause can be used to limit the updated records.: Any legal SQL where clause operating on the fields in the layer is allowed.
calcExpression - The array of field/value info objects that: contain the field or fields to update and their scalar values or SQL expression. Allowed types are dictionary and list. List must be a list of dictionary objects. Calculation Format is as follows:

{“field” : “<field name>”, “value” : “<value>”}
sqlFormat - The SQL format for the calcExpression. It can be: either standard SQL92 (standard) or native SQL (native). The default is standard. Values: standard, native

Output:

JSON as string

Usage: >>>print(fl.calculate(where=”OBJECTID < 2”,

calcExpression={“field”: “ZONE”,

“value” : “R1”}))

{‘updatedFeatureCount’: 1, ‘success’: True}

container¶: The feature layer collection to which this layer belongs.

delete_features(deletes=None, where=None, geometry_filter=None, gdb_version=None, rollback_on_failure=True)¶

This operation deletes features in a feature layer or table Inputs:

deletes - string of OIDs to remove from service where - A where clause for the query filter.

Any legal SQL where clause operating on the fields in the layer is allowed. Features conforming to the specified where clause will be deleted.

geometry_filter - spatial filter from arcgis.geometry.filters module to filter results by a

spatial relationship with another geometry

gdb_version - Geodatabase version to apply the edits. rollback_on_failure - Optional parameter to specify if the

edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

Output:: dictionary of messages

edit_features(adds=None, updates=None, deletes=None, gdb_version=None, use_global_ids=False, rollback_on_failure=True)¶

This operation adds, updates, and deletes features to the associated feature layer or table in a single call. Inputs:

adds - The array of features to be added. updates - The array of features to be updateded. deletes - string of OIDs to remove from service gdbVersion - Geodatabase version to apply the edits. useGlobalIds - instead of referencing the default Object ID

field, the service will look at a GUID field to track changes. This means the GUIDs will be passed instead of OIDs for delete, update or add features.

rollbackOnFailure - Optional parameter to specify if the

edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

Output:: dictionary of messages

classmethod fromitem(item, layer_id=0)¶: Creates a feature layer from a GIS Item. The type of item should be a ‘Feature Service’ that represents a FeatureLayerCollection. The layer_id is the id of the layer in feature layer collection (feature service).

get_html_popup(oid)¶

The htmlPopup resource provides details about the HTML pop-up authored by the user using ArcGIS for Desktop. Input:

oid - object id of the feature where the HTML pop-up

Output:

manager¶: Helper object to manage the feature layer, update it’s definition, etc

properties¶: The properties of this object

query(where='1=1', out_fields='*', time_filter=None, geometry_filter=None, return_geometry=True, return_count_only=False, return_ids_only=False, return_distinct_values=False, return_extent_only=False, group_by_fields_for_statistics=None, statistic_filter=None, result_offset=None, result_record_count=None, object_ids=None, distance=None, units=None, max_allowable_offset=None, out_sr=None, geometry_precision=None, gdb_version=None, order_by_fields=None, out_statistics=None, return_z=False, return_m=False, multipatch_option=None, quanitization_parameters=None, return_centroid=False, return_all_records=True, **kwargs)¶

queries a feature layer based on a sql statement Inputs:

where - the selection sql statement out_fields - the attribute fields to return object_ids - The object IDs of this layer or table to be

queried.

distance - The buffer distance for the input geometries.

The distance unit is specified by units. For example, if the distance is 100, the query geometry is a point, units is set to meters, and all points within 100 meters of the point are returned.

units - The unit for calculating the buffer distance. If

unit is not specified, the unit is derived from the geometry spatial reference. If the geometry spatial reference is not specified, the unit is derived from the feature service data spatial reference. This parameter only applies if supportsQueryWithDistance is true. Values: esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer | esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile

time_filter - a TimeFilter object where either the start time

or start and end time are defined to limit the search results for a given time. The values in the timeFilter should be as UTC timestampes in milliseconds. No checking occurs to see if they are in the right format.

geometry_filter - spatial filter from arcgis.geometry.filters module to filter results by a

spatial relationship with another geometry

maxAllowableOffset - This option can be used to specify the

maxAllowableOffset to be used for generalizing geometries returned by the query operation. The maxAllowableOffset is in the units of outSR. If outSR is not specified, maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

outSR - The spatial reference of the returned geometry. geometryPrecision - This option can be used to specify the

number of decimal places in the response geometries returned by the Query operation.

gdbVersion - Geodatabase version to query returnDistinctValues - If true, it returns distinct values

based on the fields specified in outFields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

returnIdsOnly - If true, the response only includes an

array of object IDs. Otherwise, the response is a feature set. The default is false.

returnCountOnly - If true, the response only includes the

count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

returnExtentOnly - If true, the response only includes the

extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

orderByFields - One or more field names on which the

features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering.

groupByFieldsForStatistics - One or more field names on

which the values need to be grouped for calculating the statistics.

outStatistics - The definitions for one or more field-based

statistics to be calculated.

returnZ - If true, Z values are included in the results if

the features have Z values. Otherwise, Z values are not returned. The default is false.

returnM - If true, M values are included in the results if

the features have M values. Otherwise, M values are not returned. The default is false.

multipatchOption - This option dictates how the geometry of

a multipatch feature will be returned.

resultOffset - This option can be used for fetching query

results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th). This option is ignored if return_all_records is True (i.e. by default).

resultRecordCount - This option can be used for fetching

query results up to the resultRecordCount specified. When resultOffset is specified but this parameter is not, the map service defaults it to maxRecordCount. The maximum value for this parameter is the value of the layer’s maxRecordCount property. This option is ignored if return_all_records is True (i.e. by default).

quanitizationParameters - Used to project the geometry onto

a virtual grid, likely representing pixels on the screen.

returnCentroid - Used to return the geometry centroid

associated with each feature returned. If true, the result includes the geometry centroid. The default is false.

return_all_records - When True, the query operation will call

the service until all records that satisfy the where_clause are returned. Note: result_offset and result_record_count will be ignored if return_all_records is True. Also, if return_count_only, return_ids_only, or return_extent_only are True, this parameter will be ignored.

kwargs - optional parameters that can be passed to the Query

function. This will allow users to pass additional parameters not explicitly implemented on the function. A complete list of functions available is documented on the Query REST API.

Output:: A FeatureSet containing the features matching the query unless another return type is specified, such as count

query_related_records(object_ids, relationship_id, out_fields='*', definition_expression=None, return_geometry=True, max_allowable_offset=None, geometry_precision=None, out_wkid=None, gdb_version=None, return_z=False, return_m=False)¶

The Query operation is performed on a feature service layer resource. The result of this operation are feature sets grouped by source layer/table object IDs. Each feature set contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries. Inputs:

objectIds - the object IDs of the table/layer to be queried relationshipId - The ID of the relationship to be queried. outFields - the list of fields from the related table/layer

to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set returnGeometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the result s will include all the field values.

definitionExpression - The definition expression to be

applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

returnGeometry - If true, the feature set includes the

geometry associated with each feature. The default is true.

maxAllowableOffset - This option can be used to specify the

maxAllowableOffset to be used for generalizing geometries returned by the query operation. The maxAllowableOffset is in the units of the outSR. If outSR is not specified, then maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

geometryPrecision - This option can be used to specify the

number of decimal places in the response geometries.

outWKID - The spatial reference of the returned geometry. gdbVersion - The geodatabase version to query. This parameter

applies only if the isDataVersioned property of the layer queried is true.

returnZ - If true, Z values are included in the results if

the features have Z values. Otherwise, Z values are not returned. The default is false.

returnM - If true, M values are included in the results if

the features have M values. Otherwise, M values are not returned. The default is false.

validate_sql(sql, sql_type='where')¶

The validate_sql operation validates an SQL-92 expression or WHERE clause. The validate_sql operation ensures that an SQL-92 expression, such as one written by a user through a user interface, is correct before performing another operation that uses the expression. For example, validateSQL can be used to validate information that is subsequently passed in as part of the where parameter of the calculate operation. validate_sql also prevents SQL injection. In addition, all table and field names used in the SQL expression or WHERE clause are validated to ensure they are valid tables and fields.

Parameters:

sql:

the SQL expression of WHERE clause to validate Example: “Population > 300000”

sql_type:

Three SQL types are supported in validate_sql - where (default) - Represents the custom WHERE clause the user

can compose when querying a layer or using calculate.

expression - Represents an SQL-92 expression. Currently, expression is used as a default value expression when adding a new field or using the calculate API.
statement - Represents the full SQL-92 statement that can be passed directly to the database. No current ArcGIS REST API resource or operation supports using the full SQL-92 SELECT statement directly. It has been added to the validateSQL for completeness. Values: where | expression | statement

arcgis.features.Table¶

class arcgis.features.Table(url, gis=None, container=None)¶

Tables represent entity classes with uniform properties. In addition to working with “entities with location” as features, the GIS can also work with non-spatial entities as rows in tables.

Working with tables is similar to working with feature layers, except that the rows (Features) in a table do not have a geometry, and tables ignore any geometry related operation.

calculate(where, calc_expression, sql_format='standard')¶

The calculate operation is performed on a feature layer resource. It updates the values of one or more fields in an existing feature service layer based on SQL expressions or scalar values. The calculate operation can only be used if the supportsCalculate property of the layer is true. Neither the Shape field nor system fields can be updated using calculate. System fields include ObjectId and GlobalId. See Calculate a field for more information on supported expressions

Inputs:

where - A where clause can be used to limit the updated records.: Any legal SQL where clause operating on the fields in the layer is allowed.
calcExpression - The array of field/value info objects that: contain the field or fields to update and their scalar values or SQL expression. Allowed types are dictionary and list. List must be a list of dictionary objects. Calculation Format is as follows:

{“field” : “<field name>”, “value” : “<value>”}
sqlFormat - The SQL format for the calcExpression. It can be: either standard SQL92 (standard) or native SQL (native). The default is standard. Values: standard, native

Output:

JSON as string

Usage: >>>print(fl.calculate(where=”OBJECTID < 2”,

calcExpression={“field”: “ZONE”,

“value” : “R1”}))

{‘updatedFeatureCount’: 1, ‘success’: True}

container¶: The feature layer collection to which this layer belongs.

delete_features(deletes=None, where=None, geometry_filter=None, gdb_version=None, rollback_on_failure=True)¶

This operation deletes features in a feature layer or table Inputs:

deletes - string of OIDs to remove from service where - A where clause for the query filter.

Any legal SQL where clause operating on the fields in the layer is allowed. Features conforming to the specified where clause will be deleted.

geometry_filter - spatial filter from arcgis.geometry.filters module to filter results by a

spatial relationship with another geometry

gdb_version - Geodatabase version to apply the edits. rollback_on_failure - Optional parameter to specify if the

edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

Output:: dictionary of messages

edit_features(adds=None, updates=None, deletes=None, gdb_version=None, use_global_ids=False, rollback_on_failure=True)¶

This operation adds, updates, and deletes features to the associated feature layer or table in a single call. Inputs:

adds - The array of features to be added. updates - The array of features to be updateded. deletes - string of OIDs to remove from service gdbVersion - Geodatabase version to apply the edits. useGlobalIds - instead of referencing the default Object ID

field, the service will look at a GUID field to track changes. This means the GUIDs will be passed instead of OIDs for delete, update or add features.

rollbackOnFailure - Optional parameter to specify if the

edits should be applied only if all submitted edits succeed. If false, the server will apply the edits that succeed even if some of the submitted edits fail. If true, the server will apply the edits only if all edits succeed. The default value is true.

Output:: dictionary of messages

fromitem(item, layer_id=0)¶: Creates a feature layer from a GIS Item. The type of item should be a ‘Feature Service’ that represents a FeatureLayerCollection. The layer_id is the id of the layer in feature layer collection (feature service).

get_html_popup(oid)¶

The htmlPopup resource provides details about the HTML pop-up authored by the user using ArcGIS for Desktop. Input:

oid - object id of the feature where the HTML pop-up

Output:

manager¶: Helper object to manage the feature layer, update it’s definition, etc

properties¶: The properties of this object

query(where='1=1', out_fields='*', time_filter=None, geometry_filter=None, return_geometry=True, return_count_only=False, return_ids_only=False, return_distinct_values=False, return_extent_only=False, group_by_fields_for_statistics=None, statistic_filter=None, result_offset=None, result_record_count=None, object_ids=None, distance=None, units=None, max_allowable_offset=None, out_sr=None, geometry_precision=None, gdb_version=None, order_by_fields=None, out_statistics=None, return_z=False, return_m=False, multipatch_option=None, quanitization_parameters=None, return_centroid=False, return_all_records=True, **kwargs)¶

queries a feature layer based on a sql statement Inputs:

where - the selection sql statement out_fields - the attribute fields to return object_ids - The object IDs of this layer or table to be

queried.

distance - The buffer distance for the input geometries.

The distance unit is specified by units. For example, if the distance is 100, the query geometry is a point, units is set to meters, and all points within 100 meters of the point are returned.

units - The unit for calculating the buffer distance. If

unit is not specified, the unit is derived from the geometry spatial reference. If the geometry spatial reference is not specified, the unit is derived from the feature service data spatial reference. This parameter only applies if supportsQueryWithDistance is true. Values: esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer | esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile

time_filter - a TimeFilter object where either the start time

or start and end time are defined to limit the search results for a given time. The values in the timeFilter should be as UTC timestampes in milliseconds. No checking occurs to see if they are in the right format.

geometry_filter - spatial filter from arcgis.geometry.filters module to filter results by a

spatial relationship with another geometry

maxAllowableOffset - This option can be used to specify the

maxAllowableOffset to be used for generalizing geometries returned by the query operation. The maxAllowableOffset is in the units of outSR. If outSR is not specified, maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

outSR - The spatial reference of the returned geometry. geometryPrecision - This option can be used to specify the

number of decimal places in the response geometries returned by the Query operation.

gdbVersion - Geodatabase version to query returnDistinctValues - If true, it returns distinct values

based on the fields specified in outFields. This parameter applies only if the supportsAdvancedQueries property of the layer is true.

returnIdsOnly - If true, the response only includes an

array of object IDs. Otherwise, the response is a feature set. The default is false.

returnCountOnly - If true, the response only includes the

count (number of features/records) that would be returned by a query. Otherwise, the response is a feature set. The default is false. This option supersedes the returnIdsOnly parameter. If returnCountOnly = true, the response will return both the count and the extent.

returnExtentOnly - If true, the response only includes the

extent of the features that would be returned by the query. If returnCountOnly=true, the response will return both the count and the extent. The default is false. This parameter applies only if the supportsReturningQueryExtent property of the layer is true.

orderByFields - One or more field names on which the

features/records need to be ordered. Use ASC or DESC for ascending or descending, respectively, following every field to control the ordering.

groupByFieldsForStatistics - One or more field names on

which the values need to be grouped for calculating the statistics.

outStatistics - The definitions for one or more field-based

statistics to be calculated.

returnZ - If true, Z values are included in the results if

the features have Z values. Otherwise, Z values are not returned. The default is false.

returnM - If true, M values are included in the results if

the features have M values. Otherwise, M values are not returned. The default is false.

multipatchOption - This option dictates how the geometry of

a multipatch feature will be returned.

resultOffset - This option can be used for fetching query

results by skipping the specified number of records and starting from the next record (that is, resultOffset + 1th). This option is ignored if return_all_records is True (i.e. by default).

resultRecordCount - This option can be used for fetching

query results up to the resultRecordCount specified. When resultOffset is specified but this parameter is not, the map service defaults it to maxRecordCount. The maximum value for this parameter is the value of the layer’s maxRecordCount property. This option is ignored if return_all_records is True (i.e. by default).

quanitizationParameters - Used to project the geometry onto

a virtual grid, likely representing pixels on the screen.

returnCentroid - Used to return the geometry centroid

associated with each feature returned. If true, the result includes the geometry centroid. The default is false.

return_all_records - When True, the query operation will call

the service until all records that satisfy the where_clause are returned. Note: result_offset and result_record_count will be ignored if return_all_records is True. Also, if return_count_only, return_ids_only, or return_extent_only are True, this parameter will be ignored.

kwargs - optional parameters that can be passed to the Query

function. This will allow users to pass additional parameters not explicitly implemented on the function. A complete list of functions available is documented on the Query REST API.

Output:: A FeatureSet containing the features matching the query unless another return type is specified, such as count

query_related_records(object_ids, relationship_id, out_fields='*', definition_expression=None, return_geometry=True, max_allowable_offset=None, geometry_precision=None, out_wkid=None, gdb_version=None, return_z=False, return_m=False)¶

The Query operation is performed on a feature service layer resource. The result of this operation are feature sets grouped by source layer/table object IDs. Each feature set contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries. Inputs:

objectIds - the object IDs of the table/layer to be queried relationshipId - The ID of the relationship to be queried. outFields - the list of fields from the related table/layer

to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set returnGeometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the result s will include all the field values.

definitionExpression - The definition expression to be

applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

returnGeometry - If true, the feature set includes the

geometry associated with each feature. The default is true.

maxAllowableOffset - This option can be used to specify the

maxAllowableOffset to be used for generalizing geometries returned by the query operation. The maxAllowableOffset is in the units of the outSR. If outSR is not specified, then maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

geometryPrecision - This option can be used to specify the

number of decimal places in the response geometries.

outWKID - The spatial reference of the returned geometry. gdbVersion - The geodatabase version to query. This parameter

applies only if the isDataVersioned property of the layer queried is true.

returnZ - If true, Z values are included in the results if

the features have Z values. Otherwise, Z values are not returned. The default is false.

returnM - If true, M values are included in the results if

the features have M values. Otherwise, M values are not returned. The default is false.

validate_sql(sql, sql_type='where')¶

The validate_sql operation validates an SQL-92 expression or WHERE clause. The validate_sql operation ensures that an SQL-92 expression, such as one written by a user through a user interface, is correct before performing another operation that uses the expression. For example, validateSQL can be used to validate information that is subsequently passed in as part of the where parameter of the calculate operation. validate_sql also prevents SQL injection. In addition, all table and field names used in the SQL expression or WHERE clause are validated to ensure they are valid tables and fields.

Parameters:

sql:

the SQL expression of WHERE clause to validate Example: “Population > 300000”

sql_type:

Three SQL types are supported in validate_sql - where (default) - Represents the custom WHERE clause the user

can compose when querying a layer or using calculate.

expression - Represents an SQL-92 expression. Currently, expression is used as a default value expression when adding a new field or using the calculate API.
statement - Represents the full SQL-92 statement that can be passed directly to the database. No current ArcGIS REST API resource or operation supports using the full SQL-92 SELECT statement directly. It has been added to the validateSQL for completeness. Values: where | expression | statement

arcgis.features.FeatureLayerCollection¶

class arcgis.features.FeatureLayerCollection(url, gis=None)¶

A FeatureLayerCollection is a collection of feature layers and tables, with the associated relationships among the entities.

In a web GIS, a feature layer collection is exposed as a feature service with multiple feature layers.

Instances of FeatureDatasets can be obtained from feature service Items in the GIS using FeatureLayerCollection.fromitem(item), from feature service endpoints using the constructor, or by accessing the dataset attribute of feature layer objects.

FeatureDatasets can be configured and managed using their manager helper object.

If the dataset supports the sync operation, the replicas helper object allows management and synchronization of replicas for disconnected editing of the feature layer collection.

Note: You can use the layers and tables property to get to the individual layers and tables in this feature layer collection.

fromitem(item)¶

manager¶: helper object to manage the feature layer collection, update it’s definition, etc

properties¶: The properties of this object

query(layer_defs_filter=None, geometry_filter=None, time_filter=None, return_geometry=True, return_ids_only=False, return_count_only=False, return_z=False, return_m=False, out_sr=None)¶: queries the feature layer collection

query_related_records(object_ids, relationship_id, out_fields='*', definition_expression=None, return_geometry=True, max_allowable_offset=None, geometry_precision=None, out_wkid=None, gdb_version=None, return_z=False, return_m=False)¶

The Query operation is performed on a feature service layer resource. The result of this operation are feature sets grouped by source layer/table object IDs. Each feature set contains Feature objects including the values for the fields requested by the user. For related layers, if you request geometry information, the geometry of each feature is also returned in the feature set. For related tables, the feature set does not include geometries. Inputs:

objectIds - the object IDs of the table/layer to be queried relationshipId - The ID of the relationship to be queried. outFields - the list of fields from the related table/layer

to be included in the returned feature set. This list is a comma delimited list of field names. If you specify the shape field in the list of return fields, it is ignored. To request geometry, set returnGeometry to true. You can also specify the wildcard “*” as the value of this parameter. In this case, the result s will include all the field values.

definitionExpression - The definition expression to be

applied to the related table/layer. From the list of objectIds, only those records that conform to this expression are queried for related records.

returnGeometry - If true, the feature set includes the

geometry associated with each feature. The default is true.

maxAllowableOffset - This option can be used to specify the

maxAllowableOffset to be used for generalizing geometries returned by the query operation. The maxAllowableOffset is in the units of the outSR. If outSR is not specified, then maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

geometryPrecision - This option can be used to specify the

number of decimal places in the response geometries.

outWKID - The spatial reference of the returned geometry. gdbVersion - The geodatabase version to query. This parameter

applies only if the isDataVersioned property of the layer queried is true.

returnZ - If true, Z values are included in the results if

the features have Z values. Otherwise, Z values are not returned. The default is false.

returnM - If true, M values are included in the results if

the features have M values. Otherwise, M values are not returned. The default is false.

upload(path, description=None)¶

Uploads a new item to the server. Once the operation is completed successfully, the JSON structure of the uploaded item is returned.

Parameters:

path:	path of the file to upload
description:	optional descriptive text for the upload item

arcgis.features.FeatureSet¶

class arcgis.features.FeatureSet(features, fields=None, has_z=False, has_m=False, geometry_type=None, spatial_reference=None, display_field_name=None, object_id_field_name=None, global_id_field_name=None)¶

A set of features with information about their fields, field aliases, geometry type, spatial reference etc.

FeatureSets are commonly used as input/output with several Geoprocessing Tools, and can be the obtained through the query() methods of feature layers. A FeatureSet can be combined with a layer definition to compose a FeatureCollection.

FeatureSet contains Feature objects, including the values for the fields requested by the user. For layers, if you request geometry information, the geometry of each feature is also returned in the FeatureSet. For tables, the FeatureSet does not include geometries.

If a Spatial Reference is not specified at the FeatureSet level, the FeatureSet will assume the SpatialReference of its first feature. If the SpatialReference of the first feature is also not specified, the spatial reference will be UnknownCoordinateSystem.

df¶: converts the FeatureSet to a Pandas dataframe. Requires pandas

display_field_name¶: gets/sets the displayFieldName

features¶: gets the features in the FeatureSet

fields¶: gets the fields in the FeatureSet

static from_dataframe(df)¶: returns a featureset from a Pandas’ Data or Spatial DataFrame

static from_dict(featureset_dict)¶: returns a featureset from a dict

static from_json(json_str)¶: returns a featureset from a JSON string

geometry_type¶: gets/sets the geometry Type

global_id_field_name¶: gets/sets the globalIdFieldName

has_m¶: gets/set the M-property

has_z¶: gets/sets the Z-property

object_id_field_name¶: gets/sets the object id field

save(save_location, out_name)¶

Saves a featureset object to a feature class Input:

saveLocation - output location of the data outName - name of the table the data will be saved to

Types:

*.csv - CSV file returned *.json - text file with json * If no extension, a shapefile if the path is a

folder, a featureclass if the path is a GDB

spatial_reference¶: gets the featureset’s spatial reference

to_dict()¶: converts the object to Python dictionary

to_json¶: converts the object to JSON

value¶: returns object as dictionary

arcgis.features.FeatureCollection¶

class arcgis.features.FeatureCollection(dictdata)¶

FeatureCollection is an object with a layer definition and a feature set.

It is an in-memory collection of features with rendering information.

Feature Collections can be stored as Items in the GIS, added as layers to a map or scene, passed as inputs to feature analysis tools, and returned as results from feature analysis tools if an output name for a feature layer is not specified when calling the tool.

query()¶: Returns the data in this feature collection as a FeatureSet. Filtering by where clause is not supported for feature collections

arcgis.features.SpatialDataFrame¶

class arcgis.features.SpatialDataFrame(*args, **kwargs)¶

A Spatial Dataframe is an object to manipulate, manage and translate data into new forms of information for users.

Required Parameters:

None

Optional:

param data:	panda’s dataframe containing attribute information
param geometry:	list/array/geoseries of arcgis.geometry objects
param sr:	spatial reference of the dataframe. This can be the factory code, WKT string, arcpy.SpatialReference object, or arcgis.SpatailReference object.
param gis:	passing a gis.GIS object set to Pro will ensure arcpy is installed and a full swatch of functionality is available to the end user.

JSON¶: Returns an Esri JSON representation of the geometry as a string.

T¶: Transpose index and columns

WKB¶: Returns the well-known binary (WKB) representation for OGC geometry. It provides a portable representation of a geometry value as a contiguous stream of bytes.

WKT¶: Returns the well-known text (WKT) representation for OGC geometry. It provides a portable representation of a geometry value as a text string.

abs()¶

Return an object with absolute value taken–only applicable to objects that are all numeric.

abs: type of caller

add(other, axis='columns', level=None, fill_value=None)¶

Addition of dataframe and other, element-wise (binary operator add).

Equivalent to dataframe + other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.radd

add_prefix(prefix)¶

Concatenate prefix string with panel items names.

prefix : string

with_prefix : type of caller

add_suffix(suffix)¶

Concatenate suffix string with panel items names.

suffix : string

with_suffix : type of caller

align(other, join='outer', axis=None, level=None, copy=True, fill_value=None, method=None, limit=None, fill_axis=0, broadcast_axis=None)¶

Align two object on their axes with the specified join method for each axis Index

other : DataFrame or Series join : {‘outer’, ‘inner’, ‘left’, ‘right’}, default ‘outer’ axis : allowed axis of the other object, default None

Align on index (0), columns (1), or both (None)

level: Broadcast across a level, matching Index values on the passed MultiIndex level
copy: Always returns new objects. If copy=False and no reindexing is required then original objects are returned.
fill_value: Value to use for missing values. Defaults to NaN, but can be any “compatible” value

method : str, default None limit : int, default None fill_axis : {0, 1, ‘index’, ‘columns’}, default 0

Filling axis, method and limit

broadcast_axis: Broadcast values along this axis, if aligning two objects of different dimensions

New in version 0.17.0.

(left, right): Aligned objects

all(axis=None, bool_only=None, skipna=None, level=None, **kwargs)¶

Return whether all elements are True over requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
bool_only: Include only boolean data. If None, will attempt to use everything, then use only boolean data

all : Series or DataFrame (if level specified)

angle_distance_to(second_geometry, method='GEODESIC')¶

Returns a tuple of angle and distance to another point using a measurement type.

Paramters:

second_geometry:

a second geometry

method:

PLANAR measurements reflect the projection of geographic

data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

any(axis=None, bool_only=None, skipna=None, level=None, **kwargs)¶

Return whether any element is True over requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
bool_only: Include only boolean data. If None, will attempt to use everything, then use only boolean data

any : Series or DataFrame (if level specified)

append(other, ignore_index=False, verify_integrity=False)¶

Append rows of other to the end of this frame, returning a new object. Columns not in this frame are added as new columns.

other: The data to append.
ignore_index: If True, do not use the index labels.
verify_integrity: If True, raise ValueError on creating index with duplicates.

appended : DataFrame

If a list of dict/series is passed and the keys are all contained in the DataFrame’s index, the order of the columns in the resulting DataFrame will be unchanged.

pandas.concat: or Panel objects

>>> df = pd.DataFrame([[1, 2], [3, 4]], columns=list('AB'))
>>> df
   A  B
0  1  2
1  3  4
>>> df2 = pd.DataFrame([[5, 6], [7, 8]], columns=list('AB'))
>>> df.append(df2)
   A  B
0  1  2
1  3  4
0  5  6
1  7  8

With ignore_index set to True:

>>> df.append(df2, ignore_index=True)
   A  B
0  1  2
1  3  4
2  5  6
3  7  8

apply(func, axis=0, broadcast=False, raw=False, reduce=None, args=(), **kwds)¶

Applies function along input axis of DataFrame.

Objects passed to functions are Series objects having index either the DataFrame’s index (axis=0) or the columns (axis=1). Return type depends on whether passed function aggregates, or the reduce argument if the DataFrame is empty.

func

:functionFunction to apply to each column/row

axis

:{0 or ‘index’, 1 or ‘columns’}, default 0

0 or ‘index’: apply function to each column
1 or ‘columns’: apply function to each row

broadcast

:boolean, default FalseFor aggregation functions, return object of same size with values propagated

raw

:boolean, default FalseIf False, convert each row or column into a Series. If raw=True the passed function will receive ndarray objects instead. If you are just applying a NumPy reduction function this will achieve much better performance

reduce

:boolean or None, default NoneTry to apply reduction procedures. If the DataFrame is empty, apply will use reduce to determine whether the result should be a Series or a DataFrame. If reduce is None (the default), apply’s return value will be guessed by calling func an empty Series (note: while guessing, exceptions raised by func will be ignored). If reduce is True a Series will always be returned, and if False a DataFrame will always be returned.

args

:tuplePositional arguments to pass to function in addition to the array/series

Additional keyword arguments will be passed as keywords to the function

In the current implementation apply calls func twice on the first column/row to decide whether it can take a fast or slow code path. This can lead to unexpected behavior if func has side-effects, as they will take effect twice for the first column/row.

>>> df.apply(numpy.sqrt) # returns DataFrame
>>> df.apply(numpy.sum, axis=0) # equiv to df.sum(0)
>>> df.apply(numpy.sum, axis=1) # equiv to df.sum(1)

DataFrame.applymap: For elementwise operations

applied : Series or DataFrame

applymap(func)¶

Apply a function to a DataFrame that is intended to operate elementwise, i.e. like doing map(func, series) for each series in the DataFrame

func: Python function, returns a single value from a single value

>>> df = pd.DataFrame(np.random.randn(3, 3))
>>> df
    0         1          2
0  -0.029638  1.081563   1.280300
1   0.647747  0.831136  -1.549481
2   0.513416 -0.884417   0.195343
>>> df = df.applymap(lambda x: '%.2f' % x)
>>> df
    0         1          2
0  -0.03      1.08       1.28
1   0.65      0.83      -1.55
2   0.51     -0.88       0.20

applied : DataFrame

DataFrame.apply : For operations on rows/columns

area¶: The area of a polygon feature. Empty for all other feature types.

as_arcpy¶: Returns an Esri JSON representation of the geometry as a string.

as_blocks(copy=True)¶

Convert the frame to a dict of dtype -> Constructor Types that each has a homogeneous dtype.

NOTE: the dtypes of the blocks WILL BE PRESERVED HERE (unlike in: as_matrix)

copy : boolean, default True

values : a dict of dtype -> Constructor Types

as_matrix(columns=None)¶

Convert the frame to its Numpy-array representation.

columns: list, optional, default:None: If None, return all columns, otherwise, returns specified columns.

values: If the caller is heterogeneous and contains booleans or objects, the result will be of dtype=object. See Notes.

Return is NOT a Numpy-matrix, rather, a Numpy-array.

The dtype will be a lower-common-denominator dtype (implicit upcasting); that is to say if the dtypes (even of numeric types) are mixed, the one that accommodates all will be chosen. Use this with care if you are not dealing with the blocks.

e.g. If the dtypes are float16 and float32, dtype will be upcast to float32. If dtypes are int32 and uint8, dtype will be upcase to int32.

This method is provided for backwards compatibility. Generally, it is recommended to use ‘.values’.

pandas.DataFrame.values

asfreq(freq, method=None, how=None, normalize=False)¶

Convert all TimeSeries inside to specified frequency using DateOffset objects. Optionally provide fill method to pad/backfill missing values.

freq : DateOffset object, or string method : {‘backfill’, ‘bfill’, ‘pad’, ‘ffill’, None}

Method to use for filling holes in reindexed Series pad / ffill: propagate last valid observation forward to next valid backfill / bfill: use NEXT valid observation to fill method

how: For PeriodIndex only, see PeriodIndex.asfreq
normalize: Whether to reset output index to midnight

converted : type of caller

assign(**kwargs)¶

Assign new columns to a DataFrame, returning a new object (a copy) with all the original columns in addition to the new ones.

New in version 0.16.0.

kwargs: keywords are the column names. If the values are callable, they are computed on the DataFrame and assigned to the new columns. The callable must not change input DataFrame (though pandas doesn’t check it). If the values are not callable, (e.g. a Series, scalar, or array), they are simply assigned.

df: A new DataFrame with the new columns in addition to all the existing columns.

Since kwargs is a dictionary, the order of your arguments may not be preserved. The make things predicatable, the columns are inserted in alphabetical order, at the end of your DataFrame. Assigning multiple columns within the same assign is possible, but you cannot reference other columns created within the same assign call.

>>> df = DataFrame({'A': range(1, 11), 'B': np.random.randn(10)})

Where the value is a callable, evaluated on df:

>>> df.assign(ln_A = lambda x: np.log(x.A))
    A         B      ln_A
 1  0.426905  0.000000
 2 -0.780949  0.693147
 3 -0.418711  1.098612
 4 -0.269708  1.386294
 5 -0.274002  1.609438
 6 -0.500792  1.791759
 7  1.649697  1.945910
 8 -1.495604  2.079442
 9  0.549296  2.197225
10 -0.758542  2.302585

Where the value already exists and is inserted:

>>> newcol = np.log(df['A'])
>>> df.assign(ln_A=newcol)
    A         B      ln_A
 1  0.426905  0.000000
 2 -0.780949  0.693147
 3 -0.418711  1.098612
 4 -0.269708  1.386294
 5 -0.274002  1.609438
 6 -0.500792  1.791759
 7  1.649697  1.945910
 8 -1.495604  2.079442
 9  0.549296  2.197225
10 -0.758542  2.302585

astype(dtype, copy=True, raise_on_error=True, **kwargs)¶

Cast object to input numpy.dtype Return a copy when copy = True (be really careful with this!)

dtype : numpy.dtype or Python type raise_on_error : raise on invalid input kwargs : keyword arguments to pass on to the constructor

casted : type of caller

at¶

Fast label-based scalar accessor

Similarly to loc, at provides label based scalar lookups. You can also set using these indexers.

at_time(time, asof=False)¶

Select values at particular time of day (e.g. 9:30AM).

time : datetime.time or string

values_at_time : type of caller

axes¶: Return a list with the row axis labels and column axis labels as the only members. They are returned in that order.

between_time(start_time, end_time, include_start=True, include_end=True)¶

Select values between particular times of the day (e.g., 9:00-9:30 AM).

start_time : datetime.time or string end_time : datetime.time or string include_start : boolean, default True include_end : boolean, default True

values_between_time : type of caller

bfill(axis=None, inplace=False, limit=None, downcast=None)¶: Synonym for NDFrame.fillna(method=’bfill’)

blocks¶: Internal property, property synonym for as_blocks()

bool()¶

Return the bool of a single element PandasObject.

This must be a boolean scalar value, either True or False. Raise a ValueError if the PandasObject does not have exactly 1 element, or that element is not boolean

boundary()¶: Constructs the boundary of the geometry.

bounds¶: Return a DataFrame of minx, miny, maxx, maxy values of geometry objects

boxplot(column=None, by=None, ax=None, fontsize=None, rot=0, grid=True, figsize=None, layout=None, return_type=None, **kwds)¶

Make a box plot from DataFrame column optionally grouped by some columns or other inputs

data : the pandas object holding the data column : column name or list of names, or vector

Can be any valid input to groupby

by: Column in the DataFrame to group by

ax : Matplotlib axes object, optional fontsize : int or string rot : label rotation angle figsize : A tuple (width, height) in inches grid : Setting this to True will show the grid layout : tuple (optional)

(rows, columns) for the layout of the plot

return_type

:{‘axes’, ‘dict’, ‘both’}, default ‘dict’

The kind of object to return. ‘dict’ returns a dictionary whose values are the matplotlib Lines of the boxplot; ‘axes’ returns the matplotlib axes the boxplot is drawn on; ‘both’ returns a namedtuple with the axes and dict.

When grouping with by, a dict mapping columns to return_type is returned.

kwds

:other plotting keyword arguments to be passed to matplotlib boxplotfunction

lines : dict ax : matplotlib Axes (ax, lines): namedtuple

Use return_type='dict' when you want to tweak the appearance of the lines after plotting. In this case a dict containing the Lines making up the boxes, caps, fliers, medians, and whiskers is returned.

buffer(distance)¶

Constructs a polygon at a specified distance from the geometry.

Parameters:

distance:

length in current projection. Only polygon accept

negative values.

centroid¶: The true centroid if it is within or on the feature; otherwise, the label point is returned. Returns a point object.

clip(envelope)¶

Constructs the intersection of the geometry and the specified extent.

Parameters:

envelope:	arcpy.Extent object

clip_lower(threshold, axis=None)¶

Return copy of the input with values below given value(s) truncated.

threshold : float or array_like axis : int or string axis name, optional

Align object with threshold along the given axis.

clip

clipped : same type as input

clip_upper(threshold, axis=None)¶

Return copy of input with values above given value(s) truncated.

threshold : float or array_like axis : int or string axis name, optional

Align object with threshold along the given axis.

clip

clipped : same type as input

combine(other, func, fill_value=None, overwrite=True)¶

Add two DataFrame objects and do not propagate NaN values, so if for a (column, time) one frame is missing a value, it will default to the other frame’s value (which might be NaN as well)

other : DataFrame func : function fill_value : scalar value overwrite : boolean, default True

If True then overwrite values for common keys in the calling frame

result : DataFrame

combineAdd(other)¶

DEPRECATED. Use DataFrame.add(other, fill_value=0.) instead.

Add two DataFrame objects and do not propagate NaN values, so if for a (column, time) one frame is missing a value, it will default to the other frame’s value (which might be NaN as well)

other : DataFrame

DataFrame

DataFrame.add

combineMult(other)¶

DEPRECATED. Use DataFrame.mul(other, fill_value=1.) instead.

Multiply two DataFrame objects and do not propagate NaN values, so if for a (column, time) one frame is missing a value, it will default to the other frame’s value (which might be NaN as well)

other : DataFrame

DataFrame

DataFrame.mul

combine_first(other)¶

Combine two DataFrame objects and default to non-null values in frame calling the method. Result index columns will be the union of the respective indexes and columns

other : DataFrame

a’s values prioritized, use values from b to fill holes:

>>> a.combine_first(b)

combined : DataFrame

compound(axis=None, skipna=None, level=None)¶

Return the compound percentage of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

compounded : Series or DataFrame (if level specified)

consolidate(inplace=False)¶

Compute NDFrame with “consolidated” internals (data of each dtype grouped together in a single ndarray). Mainly an internal API function, but available here to the savvy user

inplace: If False return new object, otherwise modify existing object

consolidated : type of caller

contains(second_geometry, relation=None)¶

Indicates if the base geometry contains the comparison geometry.

Paramters:

second_geometry:
	a second geometry

convert_objects(convert_dates=True, convert_numeric=False, convert_timedeltas=True, copy=True)¶

Deprecated.

Attempt to infer better dtype for object columns

convert_dates: If True, convert to date where possible. If ‘coerce’, force conversion, with unconvertible values becoming NaT.
convert_numeric: If True, attempt to coerce to numbers (including strings), with unconvertible values becoming NaN.
convert_timedeltas: If True, convert to timedelta where possible. If ‘coerce’, force conversion, with unconvertible values becoming NaT.
copy: If True, return a copy even if no copy is necessary (e.g. no conversion was done). Note: This is meant for internal use, and should not be confused with inplace.

pandas.to_datetime : Convert argument to datetime. pandas.to_timedelta : Convert argument to timedelta. pandas.to_numeric : Return a fixed frequency timedelta index,

with day as the default.

converted : same as input object

convex_hull()¶: Constructs the geometry that is the minimal bounding polygon such that all outer angles are convex.

copy(deep=True)¶

Make a copy of this SpatialDataFrame object Parameters:

Deep:	boolean, default True Make a deep copy, i.e. also copy data

Returns:

copy:	of SpatialDataFrame

corr(method='pearson', min_periods=1)¶

Compute pairwise correlation of columns, excluding NA/null values

method

:{‘pearson’, ‘kendall’, ‘spearman’}

pearson : standard correlation coefficient
kendall : Kendall Tau correlation coefficient
spearman : Spearman rank correlation

min_periods

:int, optionalMinimum number of observations required per pair of columns to have a valid result. Currently only available for pearson and spearman correlation

y : DataFrame

corrwith(other, axis=0, drop=False)¶

Compute pairwise correlation between rows or columns of two DataFrame objects.

other : DataFrame axis : {0 or ‘index’, 1 or ‘columns’}, default 0

0 or ‘index’ to compute column-wise, 1 or ‘columns’ for row-wise

drop: Drop missing indices from result, default returns union of all

correls : Series

count(axis=0, level=None, numeric_only=False)¶

Return Series with number of non-NA/null observations over requested axis. Works with non-floating point data as well (detects NaN and None)

axis: 0 or ‘index’ for row-wise, 1 or ‘columns’ for column-wise
level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a DataFrame
numeric_only: Include only float, int, boolean data

count : Series (or DataFrame if level specified)

cov(min_periods=None)¶

Compute pairwise covariance of columns, excluding NA/null values

min_periods: Minimum number of observations required per pair of columns to have a valid result.

y : DataFrame

y contains the covariance matrix of the DataFrame’s time series. The covariance is normalized by N-1 (unbiased estimator).

crosses(second_geometry)¶

Indicates if the two geometries intersect in a geometry of a lesser shape type.

Paramters:

second_geometry:
	a second geometry

cummax(axis=None, dtype=None, out=None, skipna=True, **kwargs)¶

Return cumulative cummax over requested axis.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

cummax : Series

cummin(axis=None, dtype=None, out=None, skipna=True, **kwargs)¶

Return cumulative cummin over requested axis.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

cummin : Series

cumprod(axis=None, dtype=None, out=None, skipna=True, **kwargs)¶

Return cumulative cumprod over requested axis.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

cumprod : Series

cumsum(axis=None, dtype=None, out=None, skipna=True, **kwargs)¶

Return cumulative cumsum over requested axis.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

cumsum : Series

cut(cutter)¶

Splits this geometry into a part left of the cutting polyline, and a part right of it.

Parameters:

cutter:	The cutting polyline geometry.

densify(method, distance, deviation)¶

Creates a new geometry with added vertices

Parameters:

method:

The type of densification, DISTANCE, ANGLE, or GEODESIC

distance:

The maximum distance between vertices. The actual

distance between vertices will usually be less than the maximum distance as new vertices will be evenly distributed along the original segment. If using a type of DISTANCE or ANGLE, the distance is measured in the units of the geometry’s spatial reference. If using a type of GEODESIC, the distance is measured in meters.

deviation:

Densify uses straight lines to approximate curves.

You use deviation to control the accuracy of this approximation. The deviation is the maximum distance between the new segment and the original curve. The smaller its value, the more segments will be required to approximate the curve.

describe(percentiles=None, include=None, exclude=None)¶

Generate various summary statistics, excluding NaN values.

percentiles

:array-like, optionalThe percentiles to include in the output. Should all be in the interval [0, 1]. By default percentiles is [.25, .5, .75], returning the 25th, 50th, and 75th percentiles.

include, exclude

:list-like, ‘all’, or None (default)

Specify the form of the returned result. Either:

None to both (default). The result will include only numeric-typed columns or, if none are, only categorical columns.
A list of dtypes or strings to be included/excluded. To select all numeric types use numpy numpy.number. To select categorical objects use type object. See also the select_dtypes documentation. eg. df.describe(include=[‘O’])
If include is the string ‘all’, the output column-set will match the input one.

summary: NDFrame of summary statistics

The output DataFrame index depends on the requested dtypes:

For numeric dtypes, it will include: count, mean, std, min, max, and lower, 50, and upper percentiles.

For object dtypes (e.g. timestamps or strings), the index will include the count, unique, most common, and frequency of the most common. Timestamps also include the first and last items.

For mixed dtypes, the index will be the union of the corresponding output types. Non-applicable entries will be filled with NaN. Note that mixed-dtype outputs can only be returned from mixed-dtype inputs and appropriate use of the include/exclude arguments.

If multiple values have the highest count, then the count and most common pair will be arbitrarily chosen from among those with the highest count.

The include, exclude arguments are ignored for Series.

DataFrame.select_dtypes

diff(periods=1, axis=0)¶

1st discrete difference of object

periods: Periods to shift for forming difference
axis: Take difference over rows (0) or columns (1).

diffed : DataFrame

difference(second_geometry)¶

Constructs the geometry that is composed only of the region unique to the base geometry but not part of the other geometry. The following illustration shows the results when the red polygon is the source geometry.

Paramters:

second_geometry:
	a second geometry

disjoint(second_geometry)¶

Indicates if the base and comparison geometries share no points in common.

Paramters:

second_geometry:
	a second geometry

distance_to(second_geometry)¶

Returns the minimum distance between two geometries. If the geometries intersect, the minimum distance is 0. Both geometries must have the same projection.

Paramters:

second_geometry:
	a second geometry

div(other, axis='columns', level=None, fill_value=None)¶

Floating division of dataframe and other, element-wise (binary operator truediv).

Equivalent to dataframe / other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rtruediv

divide(other, axis='columns', level=None, fill_value=None)¶

Floating division of dataframe and other, element-wise (binary operator truediv).

Equivalent to dataframe / other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rtruediv

dot(other)¶

Matrix multiplication with DataFrame or Series objects

other : DataFrame or Series

dot_product : DataFrame or Series

drop(labels, axis=0, level=None, inplace=False, errors='raise')¶

Return new object with labels in requested axis removed.

labels : single label or list-like axis : int or axis name level : int or level name, default None

For MultiIndex

inplace: If True, do operation inplace and return None.
errors: If ‘ignore’, suppress error and existing labels are dropped.

New in version 0.16.1.

dropped : type of caller

drop_duplicates(subset=None, keep='first', inplace=False)¶

Return DataFrame with duplicate rows removed, optionally only considering certain columns

subset

:column label or sequence of labels, optionalOnly consider certain columns for identifying duplicates, by default use all of the columns

keep

:{‘first’, ‘last’, False}, default ‘first’

first : Drop duplicates except for the first occurrence.
last : Drop duplicates except for the last occurrence.
False : Drop all duplicates.

take_last : deprecated inplace : boolean, default False

Whether to drop duplicates in place or to return a copy

deduplicated : DataFrame

dropna(axis=0, how='any', thresh=None, subset=None, inplace=False)¶

Return object with labels on given axis omitted where alternately any or all of the data are missing

axis

:{0 or ‘index’, 1 or ‘columns’}, or tuple/list thereofPass tuple or list to drop on multiple axes

how

:{‘any’, ‘all’}

any : if any NA values are present, drop that label
all : if all values are NA, drop that label

thresh

:int, default Noneint value : require that many non-NA values

subset

:array-likeLabels along other axis to consider, e.g. if you are dropping rows these would be a list of columns to include

inplace

:boolean, default FalseIf True, do operation inplace and return None.

dropped : DataFrame

dtypes¶: Return the dtypes in this object.

duplicated(subset=None, keep='first')¶

Return boolean Series denoting duplicate rows, optionally only considering certain columns

subset

:column label or sequence of labels, optionalOnly consider certain columns for identifying duplicates, by default use all of the columns

keep

:{‘first’, ‘last’, False}, default ‘first’

first : Mark duplicates as True except for the first occurrence.
last : Mark duplicates as True except for the last occurrence.
False : Mark all duplicates as True.

take_last : deprecated

duplicated : Series

empty¶

True if NDFrame is entirely empty [no items], meaning any of the axes are of length 0.

If NDFrame contains only NaNs, it is still not considered empty. See the example below.

An example of an actual empty DataFrame. Notice the index is empty:

>>> df_empty = pd.DataFrame({'A' : []})
>>> df_empty
Empty DataFrame
Columns: [A]
Index: []
>>> df_empty.empty
True

If we only have NaNs in our DataFrame, it is not considered empty! We will need to drop the NaNs to make the DataFrame empty:

>>> df = pd.DataFrame({'A' : [np.nan]})
>>> df
    A
0 NaN
>>> df.empty
False
>>> df.dropna().empty
True

pandas.Series.dropna pandas.DataFrame.dropna

eq(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods eq

equals(second_geometry)¶

Indicates if the base and comparison geometries are of the same shape type and define the same set of points in the plane. This is a 2D comparison only; M and Z values are ignored. Paramters:

second_geometry:

a second geometry

erase(other, inplace=False)¶: Erases

eval(expr, inplace=None, **kwargs)¶

Evaluate an expression in the context of the calling DataFrame instance.

expr

:stringThe expression string to evaluate.

inplace

:bool

If the expression contains an assignment, whether to return a new DataFrame or mutate the existing.

WARNING: inplace=None currently falls back to to True, but in a future version, will default to False. Use inplace=True explicitly rather than relying on the default.

New in version 0.18.0.

kwargs

:dictSee the documentation for eval() for complete details on the keyword arguments accepted by query().

ret : ndarray, scalar, or pandas object

pandas.DataFrame.query pandas.DataFrame.assign pandas.eval

For more details see the API documentation for eval(). For detailed examples see enhancing performance with eval.

>>> from numpy.random import randn
>>> from pandas import DataFrame
>>> df = DataFrame(randn(10, 2), columns=list('ab'))
>>> df.eval('a + b')
>>> df.eval('c = a + b')

ewm(com=None, span=None, halflife=None, alpha=None, min_periods=0, freq=None, adjust=True, ignore_na=False, axis=0)¶

Provides exponential weighted functions

New in version 0.18.0.

com: Specify decay in terms of center of mass,
span: Specify decay in terms of span,
halflife: Specify decay in terms of half-life,
alpha: Specify smoothing factor directly,

New in version 0.18.0.
min_periods: Minimum number of observations in window required to have a value (otherwise result is NA).
freq: Frequency to conform to before computing statistic
adjust: Divide by decaying adjustment factor in beginning periods to account for imbalance in relative weightings (viewing EWMA as a moving average)
ignore_na: Ignore missing values when calculating weights; specify True to reproduce pre-0.15.0 behavior

a Window sub-classed for the particular operation

Exactly one of center of mass, span, half-life, and alpha must be provided. Allowed values and relationship between the parameters are specified in the parameter descriptions above; see the link at the end of this section for a detailed explanation.

The freq keyword is used to conform time series data to a specified frequency by resampling the data. This is done with the default parameters of resample() (i.e. using the mean).

When adjust is True (default), weighted averages are calculated using weights (1-alpha)**(n-1), (1-alpha)**(n-2), ..., 1-alpha, 1.

When adjust is False, weighted averages are calculated recursively as:: weighted_average[0] = arg[0]; weighted_average[i] = (1-alpha)*weighted_average[i-1] + alpha*arg[i].

When ignore_na is False (default), weights are based on absolute positions. For example, the weights of x and y used in calculating the final weighted average of [x, None, y] are (1-alpha)**2 and 1 (if adjust is True), and (1-alpha)**2 and alpha (if adjust is False).

When ignore_na is True (reproducing pre-0.15.0 behavior), weights are based on relative positions. For example, the weights of x and y used in calculating the final weighted average of [x, None, y] are 1-alpha and 1 (if adjust is True), and 1-alpha and alpha (if adjust is False).

More details can be found at http://pandas.pydata.org/pandas-docs/stable/computation.html#exponentially-weighted-windows

expanding(min_periods=1, freq=None, center=False, axis=0)¶

Provides expanding transformations.

New in version 0.18.0.

min_periods: Minimum number of observations in window required to have a value (otherwise result is NA).
freq: Frequency to conform the data to before computing the statistic. Specified as a frequency string or DateOffset object.
center: Set the labels at the center of the window.

axis : int, default 0

a Window sub-classed for the particular operation

By default, the result is set to the right edge of the window. This can be changed to the center of the window by setting center=True.

The freq keyword is used to conform time series data to a specified frequency by resampling the data. This is done with the default parameters of resample() (i.e. using the mean).

extent¶: the extent of the geometry

ffill(axis=None, inplace=False, limit=None, downcast=None)¶: Synonym for NDFrame.fillna(method=’ffill’)

fillna(value=None, method=None, axis=None, inplace=False, limit=None, downcast=None, **kwargs)¶

Fill NA/NaN values using the specified method

value: Value to use to fill holes (e.g. 0), alternately a dict/Series/DataFrame of values specifying which value to use for each index (for a Series) or column (for a DataFrame). (values not in the dict/Series/DataFrame will not be filled). This value cannot be a list.
method: Method to use for filling holes in reindexed Series pad / ffill: propagate last valid observation forward to next valid backfill / bfill: use NEXT valid observation to fill gap

axis : {0, 1, ‘index’, ‘columns’} inplace : boolean, default False

If True, fill in place. Note: this will modify any other views on this object, (e.g. a no-copy slice for a column in a DataFrame).

limit: If method is specified, this is the maximum number of consecutive NaN values to forward/backward fill. In other words, if there is a gap with more than this number of consecutive NaNs, it will only be partially filled. If method is not specified, this is the maximum number of entries along the entire axis where NaNs will be filled.
downcast: a dict of item->dtype of what to downcast if possible, or the string ‘infer’ which will try to downcast to an appropriate equal type (e.g. float64 to int64 if possible)

reindex, asfreq

filled : DataFrame

filter(items=None, like=None, regex=None, axis=None)¶

Restrict the info axis to set of items or wildcard

items: List of info axis to restrict to (must not all be present)
like: Keep info axis where “arg in col == True”
regex: Keep info axis with re.search(regex, col) == True
axis: The axis to filter on. By default this is the info axis. The “info axis” is the axis that is used when indexing with []. For example, df = DataFrame({'a': [1, 2, 3, 4]]}); df['a']. So, the DataFrame columns are the info axis.

Arguments are mutually exclusive, but this is not checked for

first(offset)¶

Convenience method for subsetting initial periods of time series data based on a date offset.

offset : string, DateOffset, dateutil.relativedelta

ts.first(‘10D’) -> First 10 days

subset : type of caller

first_point¶: The first coordinate point of the geometry.

first_valid_index()¶: Return label for first non-NA/null value

floordiv(other, axis='columns', level=None, fill_value=None)¶

Integer division of dataframe and other, element-wise (binary operator floordiv).

Equivalent to dataframe // other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rfloordiv

from_csv(path, header=0, sep=', ', index_col=0, parse_dates=True, encoding=None, tupleize_cols=False, infer_datetime_format=False)¶

Read CSV file (DISCOURAGED, please use pandas.read_csv() instead).

It is preferable to use the more powerful pandas.read_csv() for most general purposes, but from_csv makes for an easy roundtrip to and from a file (the exact counterpart of to_csv), especially with a DataFrame of time series data.

This method only differs from the preferred pandas.read_csv() in some defaults:

index_col is 0 instead of None (take first column as index by default)
parse_dates is True instead of False (try parsing the index as datetime by default)

So a pd.DataFrame.from_csv(path) can be replaced by pd.read_csv(path, index_col=0, parse_dates=True).

path : string file path or file handle / StringIO header : int, default 0

Row to use as header (skip prior rows)

sep: Field delimiter
index_col: Column to use for index. If a sequence is given, a MultiIndex is used. Different default from read_table
parse_dates: Parse dates. Different default from read_table
tupleize_cols: write multi_index columns as a list of tuples (if True) or new (expanded format) if False)
infer_datetime_format: boolean, default False: If True and parse_dates is True for a column, try to infer the datetime format based on the first datetime string. If the format can be inferred, there often will be a large parsing speed-up.

pandas.read_csv

y : DataFrame

from_dict(data, orient='columns', dtype=None)¶

Construct DataFrame from dict of array-like or dicts

data: {field : array-like} or {field : dict}
orient: The “orientation” of the data. If the keys of the passed dict should be the columns of the resulting DataFrame, pass ‘columns’ (default). Otherwise if the keys should be rows, pass ‘index’.
dtype: Data type to force, otherwise infer

DataFrame

static from_featureclass(filename, **kwargs)¶

Returns a SpatialDataFrame from a feature class. Inputs:

filename: full path to the feature class

Optional Parameters:: sql_clause: sql clause to parse data down where_clause: where statement sr: spatial reference object

static from_hdf(path_or_buf, key=None, **kwargs)¶

read from the store, close it if we opened it

Retrieve pandas object stored in file, optionally based on where criteria

path_or_buf: py._path.local.LocalPath) to read from

New in version 0.19.0: support for pathlib, py.path.
key: contains a single pandas object.

where : list of Term (or convertable) objects, optional start : optional, integer (defaults to None), row number to start

selection

stop: selection
columns: return columns

iterator : optional, boolean, return an iterator, default False chunksize : optional, nrows to include in iteration, return an iterator

The selected object

from_items(items, columns=None, orient='columns')¶

Convert (key, value) pairs to DataFrame. The keys will be the axis index (usually the columns, but depends on the specified orientation). The values should be arrays or Series.

items: Values should be arrays or Series.
columns: Must be passed if orient=’index’.
orient: The “orientation” of the data. If the keys of the input correspond to column labels, pass ‘columns’ (default). Otherwise if the keys correspond to the index, pass ‘index’.

frame : DataFrame

static from_layer(layer, **kwargs)¶

Returns a SpatialDataFrame from a FeatureLayer or Table object. Inputs:

param layer: FeatureLayer or Table

param gis: GIS object

Returns a SpatialDataFrame for services with geometry and Panda’s Dataframe for table services.

from_records(data, index=None, exclude=None, columns=None, coerce_float=False, nrows=None)¶

Convert structured or record ndarray to DataFrame

data : ndarray (structured dtype), list of tuples, dict, or DataFrame index : string, list of fields, array-like

Field of array to use as the index, alternately a specific set of input labels to use

exclude: Columns or fields to exclude
columns: Column names to use. If the passed data do not have names associated with them, this argument provides names for the columns. Otherwise this argument indicates the order of the columns in the result (any names not found in the data will become all-NA columns)
coerce_float: Attempt to convert values to non-string, non-numeric objects (like decimal.Decimal) to floating point, useful for SQL result sets

df : DataFrame

ftypes¶: Return the ftypes (indication of sparse/dense and dtype) in this object.

ge(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods ge

generalize(max_offset)¶

Creates a new simplified geometry using a specified maximum offset tolerance.

Parameters:

max_offset:	The maximum offset tolerance.

geoextent¶: returns the extent of the spatial dataframe

geometry¶: Get/Set the geometry data for SpatialDataFrame

geometry_type¶: The geometry type: polygon, polyline, point, multipoint, multipatch, dimension, or annotation

get(key, default=None)¶

Get item from object for given key (DataFrame column, Panel slice, etc.). Returns default value if not found.

key : object

value : type of items contained in object

get_area(method, units=None)¶

Returns the area of the feature using a measurement type.

Parameters:

method:

PLANAR measurements reflect the projection of

geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

units:

Areal unit of measure keywords: ACRES | ARES | HECTARES

SQUARECENTIMETERS | SQUAREDECIMETERS | SQUAREINCHES | SQUAREFEET

SQUAREKILOMETERS | SQUAREMETERS | SQUAREMILES |

SQUAREMILLIMETERS | SQUAREYARDS

get_dtype_counts()¶: Return the counts of dtypes in this object.

get_ftype_counts()¶: Return the counts of ftypes in this object.

get_length(method, units)¶

Returns the length of the feature using a measurement type.

Parameters:

method:

PLANAR measurements reflect the projection of

geographic data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

units:

Linear unit of measure keywords: CENTIMETERS |

get_part(index=None)¶

Returns an array of point objects for a particular part of geometry or an array containing a number of arrays, one for each part.

Parameters:

index:	The index position of the geometry.

get_value(index, col, takeable=False)¶

Quickly retrieve single value at passed column and index

index : row label col : column label takeable : interpret the index/col as indexers, default False

value : scalar value

get_values()¶: same as values (but handles sparseness conversions)

groupby(by=None, axis=0, level=None, as_index=True, sort=True, group_keys=True, squeeze=False, **kwargs)¶

Group series using mapper (dict or key function, apply given function to group, return result as series) or by a series of columns.

by: list of column names. Called on each element of the object index to determine the groups. If a dict or Series is passed, the Series or dict VALUES will be used to determine the groups

axis : int, default 0 level : int, level name, or sequence of such, default None

If the axis is a MultiIndex (hierarchical), group by a particular level or levels

as_index: For aggregated output, return object with group labels as the index. Only relevant for DataFrame input. as_index=False is effectively “SQL-style” grouped output
sort: Sort group keys. Get better performance by turning this off. Note this does not influence the order of observations within each group. groupby preserves the order of rows within each group.
group_keys: When calling apply, add group keys to index to identify pieces
squeeze: reduce the dimensionality of the return type if possible, otherwise return a consistent type

DataFrame results

>>> data.groupby(func, axis=0).mean()
>>> data.groupby(['col1', 'col2'])['col3'].mean()

DataFrame with hierarchical index

>>> data.groupby(['col1', 'col2']).mean()

GroupBy object

gt(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods gt

head(n=5)¶: Returns first n rows

hist(data, column=None, by=None, grid=True, xlabelsize=None, xrot=None, ylabelsize=None, yrot=None, ax=None, sharex=False, sharey=False, figsize=None, layout=None, bins=10, **kwds)¶

Draw histogram of the DataFrame’s series using matplotlib / pylab.

data : DataFrame column : string or sequence

If passed, will be used to limit data to a subset of columns

by: If passed, then used to form histograms for separate groups
grid: Whether to show axis grid lines
xlabelsize: If specified changes the x-axis label size
xrot: rotation of x axis labels
ylabelsize: If specified changes the y-axis label size
yrot: rotation of y axis labels

ax : matplotlib axes object, default None sharex : boolean, default True if ax is None else False

In case subplots=True, share x axis and set some x axis labels to invisible; defaults to True if ax is None otherwise False if an ax is passed in; Be aware, that passing in both an ax and sharex=True will alter all x axis labels for all subplots in a figure!

sharey: In case subplots=True, share y axis and set some y axis labels to invisible
figsize: The size of the figure to create in inches by default

layout: (optional) a tuple (rows, columns) for the layout of the histograms bins: integer, default 10

Number of histogram bins to be used

kwds: To be passed to hist function

hull_rectangle¶: A space-delimited string of the coordinate pairs of the convex hull rectangle.

iat¶

Fast integer location scalar accessor.

Similarly to iloc, iat provides integer based lookups. You can also set using these indexers.

icol(i)¶: DEPRECATED. Use .iloc[:, i] instead

idxmax(axis=0, skipna=True)¶

Return index of first occurrence of maximum over requested axis. NA/null values are excluded.

axis: 0 or ‘index’ for row-wise, 1 or ‘columns’ for column-wise
skipna: Exclude NA/null values. If an entire row/column is NA, the result will be first index.

idxmax : Series

This method is the DataFrame version of ndarray.argmax.

Series.idxmax

idxmin(axis=0, skipna=True)¶

Return index of first occurrence of minimum over requested axis. NA/null values are excluded.

axis: 0 or ‘index’ for row-wise, 1 or ‘columns’ for column-wise
skipna: Exclude NA/null values. If an entire row/column is NA, the result will be NA

idxmin : Series

This method is the DataFrame version of ndarray.argmin.

Series.idxmin

iget_value(i, j)¶: DEPRECATED. Use .iat[i, j] instead

iloc¶

Purely integer-location based indexing for selection by position.

.iloc[] is primarily integer position based (from 0 to length-1 of the axis), but may also be used with a boolean array.

Allowed inputs are:

An integer, e.g. 5.
A list or array of integers, e.g. [4, 3, 0].
A slice object with ints, e.g. 1:7.
A boolean array.
A callable function with one argument (the calling Series, DataFrame or Panel) and that returns valid output for indexing (one of the above)

.iloc will raise IndexError if a requested indexer is out-of-bounds, except slice indexers which allow out-of-bounds indexing (this conforms with python/numpy slice semantics).

See more at Selection by Position

info(verbose=None, buf=None, max_cols=None, memory_usage=None, null_counts=None)¶

Concise summary of a DataFrame.

verbose: Whether to print the full summary. None follows the display.max_info_columns setting. True or False overrides the display.max_info_columns setting.

buf : writable buffer, defaults to sys.stdout max_cols : int, default None

Determines whether full summary or short summary is printed. None follows the display.max_info_columns setting.

memory_usage

:boolean/string, default NoneSpecifies whether total memory usage of the DataFrame elements (including index) should be displayed. None follows the display.memory_usage setting. True or False overrides the display.memory_usage setting. A value of ‘deep’ is equivalent of True, with deep introspection. Memory usage is shown in human-readable units (base-2 representation).

null_counts

:boolean, default None

Whether to show the non-null counts

If None, then only show if the frame is smaller than max_info_rows and max_info_columns.
If True, always show counts.
If False, never show counts.

insert(loc, column, value, allow_duplicates=False)¶

Insert column into DataFrame at specified location.

If allow_duplicates is False, raises Exception if column is already contained in the DataFrame.

loc: Must have 0 <= loc <= len(columns)

column : object value : int, Series, or array-like

interpolate(method='linear', axis=0, limit=None, inplace=False, limit_direction='forward', downcast=None, **kwargs)¶

Interpolate values according to different methods.

Please note that only method='linear' is supported for DataFrames/Series with a MultiIndex.

method

:{‘linear’, ‘time’, ‘index’, ‘values’, ‘nearest’, ‘zero’,

‘slinear’, ‘quadratic’, ‘cubic’, ‘barycentric’, ‘krogh’, ‘polynomial’, ‘spline’, ‘piecewise_polynomial’, ‘from_derivatives’, ‘pchip’, ‘akima’}

‘linear’: ignore the index and treat the values as equally spaced. This is the only method supported on MultiIndexes. default
‘time’: interpolation works on daily and higher resolution data to interpolate given length of interval
‘index’, ‘values’: use the actual numerical values of the index
‘nearest’, ‘zero’, ‘slinear’, ‘quadratic’, ‘cubic’, ‘barycentric’, ‘polynomial’ is passed to scipy.interpolate.interp1d. Both ‘polynomial’ and ‘spline’ require that you also specify an order (int), e.g. df.interpolate(method=’polynomial’, order=4). These use the actual numerical values of the index.
‘krogh’, ‘piecewise_polynomial’, ‘spline’, ‘pchip’ and ‘akima’ are all wrappers around the scipy interpolation methods of similar names. These use the actual numerical values of the index. See the scipy documentation for more on their behavior here # noqa and here # noqa
‘from_derivatives’ refers to BPoly.from_derivatives which replaces ‘piecewise_polynomial’ interpolation method in scipy 0.18

New in version 0.18.1: Added support for the ‘akima’ method Added interpolate method ‘from_derivatives’ which replaces ‘piecewise_polynomial’ in scipy 0.18; backwards-compatible with scipy < 0.18

axis

:{0, 1}, default 0

0: fill column-by-column
1: fill row-by-row

limit

:int, default None.Maximum number of consecutive NaNs to fill.

limit_direction

:{‘forward’, ‘backward’, ‘both’}, defaults to ‘forward’

If limit is specified, consecutive NaNs will be filled in this direction.

New in version 0.17.0.

inplace

:bool, default FalseUpdate the NDFrame in place if possible.

downcast

:optional, ‘infer’ or None, defaults to NoneDowncast dtypes if possible.

kwargs : keyword arguments to pass on to the interpolating function.

Series or DataFrame of same shape interpolated at the NaNs

reindex, replace, fillna

Filling in NaNs

>>> s = pd.Series([0, 1, np.nan, 3])
>>> s.interpolate()
0    0
1    1
2    2
3    3
dtype: float64

intersect(second_geometry, dimension)¶

Constructs a geometry that is the geometric intersection of the two input geometries. Different dimension values can be used to create different shape types. The intersection of two geometries of the same shape type is a geometry containing only the regions of overlap between the original geometries.

Paramters:

second_geometry:

a second geometry

dimension:

The topological dimension (shape type) of the

resulting geometry.: 1 -A zero-dimensional geometry (point or multipoint). 2 -A one-dimensional geometry (polyline). 4 -A two-dimensional geometry (polygon).

irow(i, copy=False)¶: DEPRECATED. Use .iloc[i] instead

is_copy = None¶

is_empty¶: Return True for each empty geometry, False for non-empty

is_multipart¶: True, if the number of parts for the geometry is more than 1

isin(values)¶

Return boolean DataFrame showing whether each element in the DataFrame is contained in values.

values: The result will only be true at a location if all the labels match. If values is a Series, that’s the index. If values is a dictionary, the keys must be the column names, which must match. If values is a DataFrame, then both the index and column labels must match.

DataFrame of booleans

When values is a list:

>>> df = DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']})
>>> df.isin([1, 3, 12, 'a'])
       A      B
0   True   True
1  False  False
2   True  False

When values is a dict:

>>> df = DataFrame({'A': [1, 2, 3], 'B': [1, 4, 7]})
>>> df.isin({'A': [1, 3], 'B': [4, 7, 12]})
       A      B
0   True  False  # Note that B didn't match the 1 here.
1  False   True
2   True   True

When values is a Series or DataFrame:

>>> df = DataFrame({'A': [1, 2, 3], 'B': ['a', 'b', 'f']})
>>> other = DataFrame({'A': [1, 3, 3, 2], 'B': ['e', 'f', 'f', 'e']})
>>> df.isin(other)
       A      B
0   True  False
1  False  False  # Column A in `other` has a 3, but not at index 1.
2   True   True

isnull()¶

Return a boolean same-sized object indicating if the values are null.

notnull : boolean inverse of isnull

items()¶

Iterator over (column name, Series) pairs.

iterrows : Iterate over DataFrame rows as (index, Series) pairs. itertuples : Iterate over DataFrame rows as namedtuples of the values.

iteritems()¶

Iterator over (column name, Series) pairs.

iterrows : Iterate over DataFrame rows as (index, Series) pairs. itertuples : Iterate over DataFrame rows as namedtuples of the values.

iterkv(*args, **kwargs)¶: iteritems alias used to get around 2to3. Deprecated

iterrows()¶

Iterate over DataFrame rows as (index, Series) pairs.

Because iterrows returns a Series for each row, it does not preserve dtypes across the rows (dtypes are preserved across columns for DataFrames). For example,
```
>>> df = pd.DataFrame([[1, 1.5]], columns=['int', 'float'])
>>> row = next(df.iterrows())[1]
>>> row
int      1.0
float    1.5
Name: 0, dtype: float64
>>> print(row['int'].dtype)
float64
>>> print(df['int'].dtype)
int64
```
To preserve dtypes while iterating over the rows, it is better to use itertuples() which returns namedtuples of the values and which is generally faster than iterrows.
You should never modify something you are iterating over. This is not guaranteed to work in all cases. Depending on the data types, the iterator returns a copy and not a view, and writing to it will have no effect.

it: A generator that iterates over the rows of the frame.

itertuples : Iterate over DataFrame rows as namedtuples of the values. iteritems : Iterate over (column name, Series) pairs.

itertuples(index=True, name='Pandas')¶

Iterate over DataFrame rows as namedtuples, with index value as first element of the tuple.

index: If True, return the index as the first element of the tuple.
name: The name of the returned namedtuples or None to return regular tuples.

The column names will be renamed to positional names if they are invalid Python identifiers, repeated, or start with an underscore. With a large number of columns (>255), regular tuples are returned.

iterrows : Iterate over DataFrame rows as (index, Series) pairs. iteritems : Iterate over (column name, Series) pairs.

>>> df = pd.DataFrame({'col1': [1, 2], 'col2': [0.1, 0.2]},
                      index=['a', 'b'])
>>> df
   col1  col2
a     1   0.1
b     2   0.2
>>> for row in df.itertuples():
...     print(row)
...
Pandas(Index='a', col1=1, col2=0.10000000000000001)
Pandas(Index='b', col1=2, col2=0.20000000000000001)

ix¶

A primarily label-location based indexer, with integer position fallback.

.ix[] supports mixed integer and label based access. It is primarily label based, but will fall back to integer positional access unless the corresponding axis is of integer type.

.ix is the most general indexer and will support any of the inputs in .loc and .iloc. .ix also supports floating point label schemes. .ix is exceptionally useful when dealing with mixed positional and label based hierachical indexes.

However, when an axis is integer based, ONLY label based access and not positional access is supported. Thus, in such cases, it’s usually better to be explicit and use .iloc or .loc.

See more at Advanced Indexing.

join(other, on=None, how='left', lsuffix='', rsuffix='', sort=False)¶

Join columns with other DataFrame either on index or on a key column. Efficiently Join multiple DataFrame objects by index at once by passing a list.

other

:DataFrame, Series with name field set, or list of DataFrameIndex should be similar to one of the columns in this one. If a Series is passed, its name attribute must be set, and that will be used as the column name in the resulting joined DataFrame

on

:column name, tuple/list of column names, or array-likeColumn(s) to use for joining, otherwise join on index. If multiples columns given, the passed DataFrame must have a MultiIndex. Can pass an array as the join key if not already contained in the calling DataFrame. Like an Excel VLOOKUP operation

how

:{‘left’, ‘right’, ‘outer’, ‘inner’}

How to handle indexes of the two objects. Default: ‘left’ for joining on index, None otherwise

left: use calling frame’s index
right: use input frame’s index
outer: form union of indexes
inner: use intersection of indexes

lsuffix

:stringSuffix to use from left frame’s overlapping columns

rsuffix

:stringSuffix to use from right frame’s overlapping columns

sort

:boolean, default FalseOrder result DataFrame lexicographically by the join key. If False, preserves the index order of the calling (left) DataFrame

on, lsuffix, and rsuffix options are not supported when passing a list of DataFrame objects

joined : DataFrame

keys()¶

Get the ‘info axis’ (see Indexing for more)

This is index for Series, columns for DataFrame and major_axis for Panel.

kurt(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return unbiased kurtosis over requested axis using Fisher’s definition of kurtosis (kurtosis of normal == 0.0). Normalized by N-1

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

kurt : Series or DataFrame (if level specified)

kurtosis(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return unbiased kurtosis over requested axis using Fisher’s definition of kurtosis (kurtosis of normal == 0.0). Normalized by N-1

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

kurt : Series or DataFrame (if level specified)

label_point¶: The point at which the label is located. The labelPoint is always located within or on a feature.

last(offset)¶

Convenience method for subsetting final periods of time series data based on a date offset.

offset : string, DateOffset, dateutil.relativedelta

ts.last(‘5M’) -> Last 5 months

subset : type of caller

last_point¶: The last coordinate of the feature.

last_valid_index()¶: Return label for last non-NA/null value

le(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods le

length¶: The length of the linear feature. Zero for point and multipoint feature types.

length3D¶: The 3D length of the linear feature. Zero for point and multipoint feature types.

loc¶

Purely label-location based indexer for selection by label.

.loc[] is primarily label based, but may also be used with a boolean array.

Allowed inputs are:

A single label, e.g. 5 or 'a', (note that 5 is interpreted as a label of the index, and never as an integer position along the index).
A list or array of labels, e.g. ['a', 'b', 'c'].
A slice object with labels, e.g. 'a':'f' (note that contrary to usual python slices, both the start and the stop are included!).
A boolean array.
A callable function with one argument (the calling Series, DataFrame or Panel) and that returns valid output for indexing (one of the above)

.loc will raise a KeyError when the items are not found.

See more at Selection by Label

lookup(row_labels, col_labels)¶

Label-based “fancy indexing” function for DataFrame. Given equal-length arrays of row and column labels, return an array of the values corresponding to each (row, col) pair.

row_labels: The row labels to use for lookup
col_labels: The column labels to use for lookup

Akin to:

result = []
for row, col in zip(row_labels, col_labels):
    result.append(df.get_value(row, col))

values: The found values

lt(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods lt

mad(axis=None, skipna=None, level=None)¶

Return the mean absolute deviation of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

mad : Series or DataFrame (if level specified)

mask(cond, other=nan, inplace=False, axis=None, level=None, try_cast=False, raise_on_error=True)¶

Return an object of same shape as self and whose corresponding entries are from self where cond is False and otherwise are from other.

cond

:boolean NDFrame, array or callable

If cond is callable, it is computed on the NDFrame and should return boolean NDFrame or array. The callable must not change input NDFrame (though pandas doesn’t check it).

New in version 0.18.1.

A callable can be used as cond.

other

:scalar, NDFrame, or callable

If other is callable, it is computed on the NDFrame and should return scalar or NDFrame. The callable must not change input NDFrame (though pandas doesn’t check it).

New in version 0.18.1.

A callable can be used as other.

inplace

:boolean, default FalseWhether to perform the operation in place on the data

axis : alignment axis if needed, default None level : alignment level if needed, default None try_cast : boolean, default False

try to cast the result back to the input type (if possible),

raise_on_error: Whether to raise on invalid data types (e.g. trying to where on strings)

wh : same type as caller

max(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

This method returns the maximum of the values in the object.: If you want the index of the maximum, use idxmax. This is the equivalent of the numpy.ndarray method argmax.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

max : Series or DataFrame (if level specified)

mean(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return the mean of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

mean : Series or DataFrame (if level specified)

measure_on_line(second_geometry, as_percentage=False)¶

Returns a measure from the start point of this line to the in_point.

Paramters:

second_geometry:

a second geometry

as_percentage:

If False, the measure will be returned as a

distance; if True, the measure will be returned as a percentage.

median(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return the median of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

median : Series or DataFrame (if level specified)

memory_usage(index=True, deep=False)¶

Memory usage of DataFrame columns.

index: Specifies whether to include memory usage of DataFrame’s index in returned Series. If index=True (default is False) the first index of the Series is Index.
deep: Introspect the data deeply, interrogate object dtypes for system-level memory consumption

sizes: A series with column names as index and memory usage of columns with units of bytes.

Memory usage does not include memory consumed by elements that are not components of the array if deep=False

numpy.ndarray.nbytes

merge(right, how='inner', on=None, left_on=None, right_on=None, left_index=False, right_index=False, sort=False, suffixes=('_x', '_y'), copy=True, indicator=False)¶

Merge DataFrame objects by performing a database-style join operation by columns or indexes.

If joining columns on columns, the DataFrame indexes will be ignored. Otherwise if joining indexes on indexes or indexes on a column or columns, the index will be passed on.

right : DataFrame how : {‘left’, ‘right’, ‘outer’, ‘inner’}, default ‘inner’

left: use only keys from left frame (SQL: left outer join)

right: use only keys from right frame (SQL: right outer join)

outer: use union of keys from both frames (SQL: full outer join)

inner: use intersection of keys from both frames (SQL: inner join)

on: Field names to join on. Must be found in both DataFrames. If on is None and not merging on indexes, then it merges on the intersection of the columns by default.
left_on: Field names to join on in left DataFrame. Can be a vector or list of vectors of the length of the DataFrame to use a particular vector as the join key instead of columns
right_on: Field names to join on in right DataFrame or vector/list of vectors per left_on docs
left_index: Use the index from the left DataFrame as the join key(s). If it is a MultiIndex, the number of keys in the other DataFrame (either the index or a number of columns) must match the number of levels
right_index: Use the index from the right DataFrame as the join key. Same caveats as left_index
sort: Sort the join keys lexicographically in the result DataFrame
suffixes: Suffix to apply to overlapping column names in the left and right side, respectively
copy: If False, do not copy data unnecessarily
indicator: If True, adds a column to output DataFrame called “_merge” with information on the source of each row. If string, column with information on source of each row will be added to output DataFrame, and column will be named value of string. Information column is Categorical-type and takes on a value of “left_only” for observations whose merge key only appears in ‘left’ DataFrame, “right_only” for observations whose merge key only appears in ‘right’ DataFrame, and “both” if the observation’s merge key is found in both.

New in version 0.17.0.

>>> A              >>> B
    lkey value         rkey value
0   foo  1         0   foo  5
1   bar  2         1   bar  6
2   baz  3         2   qux  7
3   foo  4         3   bar  8

>>> A.merge(B, left_on='lkey', right_on='rkey', how='outer')
   lkey  value_x  rkey  value_y
foo   1        foo   5
foo   4        foo   5
bar   2        bar   6
bar   2        bar   8
baz   3        NaN   NaN
NaN   NaN      qux   7

merged: The output type will the be same as ‘left’, if it is a subclass of DataFrame.

merge_datasets(other)¶: This operation combines two dataframes into one new DataFrame. If the operation is combining two SpatialDataFrames, the geometry_type must match.

min(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

This method returns the minimum of the values in the object.: If you want the index of the minimum, use idxmin. This is the equivalent of the numpy.ndarray method argmin.

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

min : Series or DataFrame (if level specified)

mod(other, axis='columns', level=None, fill_value=None)¶

Modulo of dataframe and other, element-wise (binary operator mod).

Equivalent to dataframe % other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rmod

mode(axis=0, numeric_only=False)¶

Gets the mode(s) of each element along the axis selected. Empty if nothing has 2+ occurrences. Adds a row for each mode per label, fills in gaps with nan.

Note that there could be multiple values returned for the selected axis (when more than one item share the maximum frequency), which is the reason why a dataframe is returned. If you want to impute missing values with the mode in a dataframe df, you can just do this: df.fillna(df.mode().iloc[0])

axis

:{0 or ‘index’, 1 or ‘columns’}, default 0

0 or ‘index’ : get mode of each column
1 or ‘columns’ : get mode of each row

numeric_only

:boolean, default Falseif True, only apply to numeric columns

modes : DataFrame (sorted)

>>> df = pd.DataFrame({'A': [1, 2, 1, 2, 1, 2, 3]})
>>> df.mode()
   A
0  1
1  2

mul(other, axis='columns', level=None, fill_value=None)¶

Multiplication of dataframe and other, element-wise (binary operator mul).

Equivalent to dataframe * other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rmul

multiply(other, axis='columns', level=None, fill_value=None)¶

Multiplication of dataframe and other, element-wise (binary operator mul).

Equivalent to dataframe * other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rmul

ndim¶: Number of axes / array dimensions

ne(other, axis='columns', level=None)¶: Wrapper for flexible comparison methods ne

nlargest(n, columns, keep='first')¶

Get the rows of a DataFrame sorted by the n largest values of columns.

New in version 0.17.0.

n: Number of items to retrieve
columns: Column name or names to order by
keep: Where there are duplicate values: - first : take the first occurrence. - last : take the last occurrence.

DataFrame

>>> df = DataFrame({'a': [1, 10, 8, 11, -1],
...                 'b': list('abdce'),
...                 'c': [1.0, 2.0, np.nan, 3.0, 4.0]})
>>> df.nlargest(3, 'a')
    a  b   c
3  11  c   3
1  10  b   2
2   8  d NaN

notnull()¶

Return a boolean same-sized object indicating if the values are not null.

isnull : boolean inverse of notnull

nsmallest(n, columns, keep='first')¶

Get the rows of a DataFrame sorted by the n smallest values of columns.

New in version 0.17.0.

n: Number of items to retrieve
columns: Column name or names to order by
keep: Where there are duplicate values: - first : take the first occurrence. - last : take the last occurrence.

DataFrame

>>> df = DataFrame({'a': [1, 10, 8, 11, -1],
...                 'b': list('abdce'),
...                 'c': [1.0, 2.0, np.nan, 3.0, 4.0]})
>>> df.nsmallest(3, 'a')
   a  b   c
4 -1  e   4
0  1  a   1
2  8  d NaN

overlaps(second_geometry)¶

Indicates if the intersection of the two geometries has the same shape type as one of the input geometries and is not equivalent to either of the input geometries.

Paramters:

second_geometry:
	a second geometry

part_count¶: The number of geometry parts for the feature.

pct_change(periods=1, fill_method='pad', limit=None, freq=None, **kwargs)¶

Percent change over given number of periods.

periods: Periods to shift for forming percent change
fill_method: How to handle NAs before computing percent changes
limit: The number of consecutive NAs to fill before stopping
freq: Increment to use from time series API (e.g. ‘M’ or BDay())

chg : NDFrame

By default, the percentage change is calculated along the stat axis: 0, or Index, for DataFrame and 1, or minor for Panel. You can change this with the axis keyword argument.

pipe(func, *args, **kwargs)¶

Apply func(self, *args, **kwargs)

New in version 0.16.2.

func: function to apply to the NDFrame. args, and kwargs are passed into func. Alternatively a (callable, data_keyword) tuple where data_keyword is a string indicating the keyword of callable that expects the NDFrame.

args : positional arguments passed into func. kwargs : a dictionary of keyword arguments passed into func.

object : the return type of func.

Use .pipe when chaining together functions that expect on Series or DataFrames. Instead of writing

>>> f(g(h(df), arg1=a), arg2=b, arg3=c)

You can write

>>> (df.pipe(h)
...    .pipe(g, arg1=a)
...    .pipe(f, arg2=b, arg3=c)
... )

If you have a function that takes the data as (say) the second argument, pass a tuple indicating which keyword expects the data. For example, suppose f takes its data as arg2:

>>> (df.pipe(h)
...    .pipe(g, arg1=a)
...    .pipe((f, 'arg2'), arg1=a, arg3=c)
...  )

pandas.DataFrame.apply pandas.DataFrame.applymap pandas.Series.map

pivot(index=None, columns=None, values=None)¶

Reshape data (produce a “pivot” table) based on column values. Uses unique values from index / columns to form axes and return either DataFrame or Panel, depending on whether you request a single value column (DataFrame) or all columns (Panel)

index: Column name to use to make new frame’s index. If None, uses existing index.
columns: Column name to use to make new frame’s columns
values: Column name to use for populating new frame’s values

For finer-tuned control, see hierarchical indexing documentation along with the related stack/unstack methods

>>> df
    foo   bar  baz
 one   A    1.
 one   B    2.
 one   C    3.
 two   A    4.
 two   B    5.
 two   C    6.

>>> df.pivot('foo', 'bar', 'baz')
     A   B   C
one  1   2   3
two  4   5   6

>>> df.pivot('foo', 'bar')['baz']
     A   B   C
one  1   2   3
two  4   5   6

pivoted: If no values column specified, will have hierarchically indexed columns

pivot_table(data, values=None, index=None, columns=None, aggfunc='mean', fill_value=None, margins=False, dropna=True, margins_name='All')¶

Create a spreadsheet-style pivot table as a DataFrame. The levels in the pivot table will be stored in MultiIndex objects (hierarchical indexes) on the index and columns of the result DataFrame

data : DataFrame values : column to aggregate, optional index : column, Grouper, array, or list of the previous

If an array is passed, it must be the same length as the data. The list can contain any of the other types (except list). Keys to group by on the pivot table index. If an array is passed, it is being used as the same manner as column values.

columns: If an array is passed, it must be the same length as the data. The list can contain any of the other types (except list). Keys to group by on the pivot table column. If an array is passed, it is being used as the same manner as column values.
aggfunc: If list of functions passed, the resulting pivot table will have hierarchical columns whose top level are the function names (inferred from the function objects themselves)
fill_value: Value to replace missing values with
margins: Add all row / columns (e.g. for subtotal / grand totals)
dropna: Do not include columns whose entries are all NaN
margins_name: Name of the row / column that will contain the totals when margins is True.

>>> df
   A   B   C      D
foo one small  1
foo one large  2
foo one large  2
foo two small  3
foo two small  3
bar one large  4
bar one small  5
bar two small  6
bar two large  7

>>> table = pivot_table(df, values='D', index=['A', 'B'],
...                     columns=['C'], aggfunc=np.sum)
>>> table
          small  large
foo  one  1      4
     two  6      NaN
bar  one  5      4
     two  6      7

table : DataFrame

plot(*args, **kwargs)¶: writes the spatial dataframe to a map

point_count¶: The total number of points for the feature.

point_from_angle_and_distance(angle, distance, method='GEODESCIC')¶

Returns a point at a given angle and distance in degrees and meters using the specified measurement type.

Parameters:

angle:

The angle in degrees to the returned point.

distance:

The distance in meters to the returned point.

method:

PLANAR measurements reflect the projection of geographic

data onto the 2D surface (in other words, they will not take into account the curvature of the earth). GEODESIC, GREAT_ELLIPTIC, LOXODROME, and PRESERVE_SHAPE measurement types may be chosen as an alternative, if desired.

pop(item)¶: Return item and drop from frame. Raise KeyError if not found.

position_along_line(value, use_percentage=False)¶

Returns a point on a line at a specified distance from the beginning of the line.

Parameters:

value:

The distance along the line.

use_percentage:

The distance may be specified as a fixed unit

of measure or a ratio of the length of the line. If True, value is used as a percentage; if False, value is used as a distance. For percentages, the value should be expressed as a double from 0.0 (0%) to 1.0 (100%).

pow(other, axis='columns', level=None, fill_value=None)¶

Exponential power of dataframe and other, element-wise (binary operator pow).

Equivalent to dataframe ** other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rpow

prod(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return the product of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

prod : Series or DataFrame (if level specified)

product(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return the product of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

prod : Series or DataFrame (if level specified)

project_as(spatial_reference, transformation_name=None)¶

Projects a geometry and optionally applies a geotransformation.

Parameter:

spatial_reference:

The new spatial reference. This can be a

SpatialReference object or the coordinate system name.

transformation_name:

The geotransformation name.

quantile(q=0.5, axis=0, numeric_only=True, interpolation='linear')¶

Return values at the given quantile over requested axis, a la numpy.percentile.

q

:float or array-like, default 0.5 (50% quantile)0 <= q <= 1, the quantile(s) to compute

axis

:{0, 1, ‘index’, ‘columns’} (default 0)0 or ‘index’ for row-wise, 1 or ‘columns’ for column-wise

interpolation

:{‘linear’, ‘lower’, ‘higher’, ‘midpoint’, ‘nearest’}

New in version 0.18.0.

This optional parameter specifies the interpolation method to use, when the desired quantile lies between two data points i and j:

linear: i + (j - i) * fraction, where fraction is the fractional part of the index surrounded by i and j.
lower: i.
higher: j.
nearest: i or j whichever is nearest.
midpoint: (i + j) / 2.

quantiles : Series or DataFrame

If q is an array, a DataFrame will be returned where the index is q, the columns are the columns of self, and the values are the quantiles.

If q is a float, a Series will be returned where the index is the columns of self and the values are the quantiles.

>>> df = DataFrame(np.array([[1, 1], [2, 10], [3, 100], [4, 100]]),
                   columns=['a', 'b'])
>>> df.quantile(.1)
a    1.3
b    3.7
dtype: float64
>>> df.quantile([.1, .5])
       a     b
0.1  1.3   3.7
0.5  2.5  55.0

query(expr, inplace=False, **kwargs)¶

Query the columns of a frame with a boolean expression.

New in version 0.13.

expr: The query string to evaluate. You can refer to variables in the environment by prefixing them with an ‘@’ character like @a + b.
inplace: Whether the query should modify the data in place or return a modified copy

New in version 0.18.0.
kwargs: See the documentation for pandas.eval() for complete details on the keyword arguments accepted by DataFrame.query().

q : DataFrame

The result of the evaluation of this expression is first passed to DataFrame.loc and if that fails because of a multidimensional key (e.g., a DataFrame) then the result will be passed to DataFrame.__getitem__().

This method uses the top-level pandas.eval() function to evaluate the passed query.

The query() method uses a slightly modified Python syntax by default. For example, the & and | (bitwise) operators have the precedence of their boolean cousins, and and or. This is syntactically valid Python, however the semantics are different.

You can change the semantics of the expression by passing the keyword argument parser='python'. This enforces the same semantics as evaluation in Python space. Likewise, you can pass engine='python' to evaluate an expression using Python itself as a backend. This is not recommended as it is inefficient compared to using numexpr as the engine.

The DataFrame.index and DataFrame.columns attributes of the DataFrame instance are placed in the query namespace by default, which allows you to treat both the index and columns of the frame as a column in the frame. The identifier index is used for the frame index; you can also use the name of the index to identify it in a query.

For further details and examples see the query documentation in indexing.

pandas.eval DataFrame.eval

>>> from numpy.random import randn
>>> from pandas import DataFrame
>>> df = DataFrame(randn(10, 2), columns=list('ab'))
>>> df.query('a > b')
>>> df[df.a > df.b]  # same result as the previous expression

query_point_and_distance(second_geometry, use_percentage=False)¶

Finds the point on the polyline nearest to the in_point and the distance between those points. Also returns information about the side of the line the in_point is on as well as the distance along the line where the nearest point occurs.

Paramters:

second_geometry:

a second geometry

as_percentage:

if False, the measure will be returned as

distance, True, measure will be a percentage

radd(other, axis='columns', level=None, fill_value=None)¶

Addition of dataframe and other, element-wise (binary operator radd).

Equivalent to other + dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.add

rank(axis=0, method='average', numeric_only=None, na_option='keep', ascending=True, pct=False)¶

Compute numerical data ranks (1 through n) along axis. Equal values are assigned a rank that is the average of the ranks of those values

axis: {0 or ‘index’, 1 or ‘columns’}, default 0

index to direct ranking

method

:{‘average’, ‘min’, ‘max’, ‘first’, ‘dense’}

average: average rank of group
min: lowest rank in group
max: highest rank in group
first: ranks assigned in order they appear in the array
dense: like ‘min’, but rank always increases by 1 between groups

numeric_only

:boolean, default NoneInclude only float, int, boolean data. Valid only for DataFrame or Panel objects

na_option

:{‘keep’, ‘top’, ‘bottom’}

keep: leave NA values where they are
top: smallest rank if ascending
bottom: smallest rank if descending

ascending

:boolean, default TrueFalse for ranks by high (1) to low (N)

pct

:boolean, default FalseComputes percentage rank of data

ranks : same type as caller

rdiv(other, axis='columns', level=None, fill_value=None)¶

Floating division of dataframe and other, element-wise (binary operator rtruediv).

Equivalent to other / dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.truediv

reindex(index=None, columns=None, **kwargs)¶

Conform DataFrame to new index with optional filling logic, placing NA/NaN in locations having no value in the previous index. A new object is produced unless the new index is equivalent to the current one and copy=False

index, columns

:array-like, optional (can be specified in order, or askeywords) New labels / index to conform to. Preferably an Index object to avoid duplicating data

method

:{None, ‘backfill’/’bfill’, ‘pad’/’ffill’, ‘nearest’}, optional

method to use for filling holes in reindexed DataFrame. Please note: this is only applicable to DataFrames/Series with a monotonically increasing/decreasing index.

default: don’t fill gaps
pad / ffill: propagate last valid observation forward to next valid
backfill / bfill: use next valid observation to fill gap
nearest: use nearest valid observations to fill gap

copy

:boolean, default TrueReturn a new object, even if the passed indexes are the same

level

:int or nameBroadcast across a level, matching Index values on the passed MultiIndex level

fill_value

:scalar, default np.NaNValue to use for missing values. Defaults to NaN, but can be any “compatible” value

limit

:int, default NoneMaximum number of consecutive elements to forward or backward fill

tolerance

:optional

Maximum distance between original and new labels for inexact matches. The values of the index at the matching locations most satisfy the equation abs(index[indexer] - target) <= tolerance.

New in version 0.17.0.

Create a dataframe with some fictional data.

>>> index = ['Firefox', 'Chrome', 'Safari', 'IE10', 'Konqueror']
>>> df = pd.DataFrame({
...      'http_status': [200,200,404,404,301],
...      'response_time': [0.04, 0.02, 0.07, 0.08, 1.0]},
...       index=index)
>>> df
            http_status  response_time
Firefox            200           0.04
Chrome             200           0.02
Safari             404           0.07
IE10               404           0.08
Konqueror          301           1.00

Create a new index and reindex the dataframe. By default values in the new index that do not have corresponding records in the dataframe are assigned NaN.

>>> new_index= ['Safari', 'Iceweasel', 'Comodo Dragon', 'IE10',
...             'Chrome']
>>> df.reindex(new_index)
               http_status  response_time
Safari                 404           0.07
Iceweasel              NaN            NaN
Comodo Dragon          NaN            NaN
IE10                   404           0.08
Chrome                 200           0.02

We can fill in the missing values by passing a value to the keyword fill_value. Because the index is not monotonically increasing or decreasing, we cannot use arguments to the keyword method to fill the NaN values.

>>> df.reindex(new_index, fill_value=0)
               http_status  response_time
Safari                 404           0.07
Iceweasel                0           0.00
Comodo Dragon            0           0.00
IE10                   404           0.08
Chrome                 200           0.02

>>> df.reindex(new_index, fill_value='missing')
              http_status response_time
Safari                404          0.07
Iceweasel         missing       missing
Comodo Dragon     missing       missing
IE10                  404          0.08
Chrome                200          0.02

To further illustrate the filling functionality in reindex, we will create a dataframe with a monotonically increasing index (for example, a sequence of dates).

>>> date_index = pd.date_range('1/1/2010', periods=6, freq='D')
>>> df2 = pd.DataFrame({"prices": [100, 101, np.nan, 100, 89, 88]},
...                    index=date_index)
>>> df2
            prices
2010-01-01     100
2010-01-02     101
2010-01-03     NaN
2010-01-04     100
2010-01-05      89
2010-01-06      88

Suppose we decide to expand the dataframe to cover a wider date range.

>>> date_index2 = pd.date_range('12/29/2009', periods=10, freq='D')
>>> df2.reindex(date_index2)
            prices
2009-12-29     NaN
2009-12-30     NaN
2009-12-31     NaN
2010-01-01     100
2010-01-02     101
2010-01-03     NaN
2010-01-04     100
2010-01-05      89
2010-01-06      88
2010-01-07     NaN

The index entries that did not have a value in the original data frame (for example, ‘2009-12-29’) are by default filled with NaN. If desired, we can fill in the missing values using one of several options.

For example, to backpropagate the last valid value to fill the NaN values, pass bfill as an argument to the method keyword.

>>> df2.reindex(date_index2, method='bfill')
            prices
2009-12-29     100
2009-12-30     100
2009-12-31     100
2010-01-01     100
2010-01-02     101
2010-01-03     NaN
2010-01-04     100
2010-01-05      89
2010-01-06      88
2010-01-07     NaN

Please note that the NaN value present in the original dataframe (at index value 2010-01-03) will not be filled by any of the value propagation schemes. This is because filling while reindexing does not look at dataframe values, but only compares the original and desired indexes. If you do want to fill in the NaN values present in the original dataframe, use the fillna() method.

reindexed : DataFrame

reindex_axis(labels, axis=0, method=None, level=None, copy=True, limit=None, fill_value=nan)¶

Conform input object to new index with optional filling logic, placing NA/NaN in locations having no value in the previous index. A new object is produced unless the new index is equivalent to the current one and copy=False

labels: New labels / index to conform to. Preferably an Index object to avoid duplicating data

axis : {0, 1, ‘index’, ‘columns’} method : {None, ‘backfill’/’bfill’, ‘pad’/’ffill’, ‘nearest’}, optional

Method to use for filling holes in reindexed DataFrame:

default: don’t fill gaps

pad / ffill: propagate last valid observation forward to next valid

backfill / bfill: use next valid observation to fill gap

nearest: use nearest valid observations to fill gap

copy: Return a new object, even if the passed indexes are the same
level: Broadcast across a level, matching Index values on the passed MultiIndex level
limit: Maximum number of consecutive elements to forward or backward fill
tolerance: Maximum distance between original and new labels for inexact matches. The values of the index at the matching locations most satisfy the equation abs(index[indexer] - target) <= tolerance.

New in version 0.17.0.

>>> df.reindex_axis(['A', 'B', 'C'], axis=1)

reindex, reindex_like

reindexed : DataFrame

reindex_like(other, method=None, copy=True, limit=None, tolerance=None)¶

Return an object with matching indices to myself.

other : Object method : string or None copy : boolean, default True limit : int, default None

Maximum number of consecutive labels to fill for inexact matches.

tolerance: Maximum distance between labels of the other object and this object for inexact matches.

New in version 0.17.0.

Like calling s.reindex(index=other.index, columns=other.columns,: method=...)

reindexed : same as input

rename(index=None, columns=None, **kwargs)¶

Alter axes input function or functions. Function / dict values must be unique (1-to-1). Labels not contained in a dict / Series will be left as-is. Alternatively, change Series.name with a scalar value (Series only).

index, columns: Scalar or list-like will alter the Series.name attribute, and raise on DataFrame or Panel. dict-like or functions are transformations to apply to that axis’ values
copy: Also copy underlying data
inplace: Whether to return a new DataFrame. If True then value of copy is ignored.

renamed : DataFrame (new object)

pandas.NDFrame.rename_axis

>>> s = pd.Series([1, 2, 3])
>>> s
0    1
1    2
2    3
dtype: int64
>>> s.rename("my_name") # scalar, changes Series.name
0    1
1    2
2    3
Name: my_name, dtype: int64
>>> s.rename(lambda x: x ** 2)  # function, changes labels
0    1
1    2
4    3
dtype: int64
>>> s.rename({1: 3, 2: 5})  # mapping, changes labels
0    1
3    2
5    3
dtype: int64
>>> df = pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]})
>>> df.rename(2)
...
TypeError: 'int' object is not callable
>>> df.rename(index=str, columns={"A": "a", "B": "c"})
   a  c
0  1  4
1  2  5
2  3  6

rename_axis(mapper, axis=0, copy=True, inplace=False)¶

Alter index and / or columns using input function or functions. A scaler or list-like for mapper will alter the Index.name or MultiIndex.names attribute. A function or dict for mapper will alter the labels. Function / dict values must be unique (1-to-1). Labels not contained in a dict / Series will be left as-is.

mapper : scalar, list-like, dict-like or function, optional axis : int or string, default 0 copy : boolean, default True

Also copy underlying data

inplace : boolean, default False

renamed : type of caller

pandas.NDFrame.rename pandas.Index.rename

>>> df = pd.DataFrame({"A": [1, 2, 3], "B": [4, 5, 6]})
>>> df.rename_axis("foo")  # scalar, alters df.index.name
     A  B
foo
0    1  4
1    2  5
2    3  6
>>> df.rename_axis(lambda x: 2 * x)  # function: alters labels
   A  B
0  1  4
2  2  5
4  3  6
>>> df.rename_axis({"A": "ehh", "C": "see"}, axis="columns")  # mapping
   ehh  B
0    1  4
1    2  5
2    3  6

reorder_levels(order, axis=0)¶

Rearrange index levels using input order. May not drop or duplicate levels

order: List representing new level order. Reference level by number (position) or by key (label).
axis: Where to reorder levels.

type of caller (new object)

replace(to_replace=None, value=None, inplace=False, limit=None, regex=False, method='pad', axis=None)¶

Replace values given in ‘to_replace’ with ‘value’.

to_replace : str, regex, list, dict, Series, numeric, or None

str or regex:

str: string exactly matching to_replace will be replaced with value

regex: regexs matching to_replace will be replaced with value

list of str, regex, or numeric:

First, if to_replace and value are both lists, they must be the same length.

Second, if regex=True then all of the strings in both lists will be interpreted as regexs otherwise they will match directly. This doesn’t matter much for value since there are only a few possible substitution regexes you can use.

str and regex rules apply as above.

dict:

Nested dictionaries, e.g., {‘a’: {‘b’: nan}}, are read as follows: look in column ‘a’ for the value ‘b’ and replace it with nan. You can nest regular expressions as well. Note that column names (the top-level dictionary keys in a nested dictionary) cannot be regular expressions.

Keys map to column names and values map to substitution values. You can treat this as a special case of passing two lists except that you are specifying the column to search in.

None:

This means that the regex argument must be a string, compiled regular expression, or list, dict, ndarray or Series of such elements. If value is also None then this must be a nested dictionary or Series.

See the examples section for examples of each of these.

value: Value to use to fill holes (e.g. 0), alternately a dict of values specifying which value to use for each column (columns not in the dict will not be filled). Regular expressions, strings and lists or dicts of such objects are also allowed.
inplace: If True, in place. Note: this will modify any other views on this object (e.g. a column form a DataFrame). Returns the caller if this is True.
limit: Maximum size gap to forward or backward fill
regex: Whether to interpret to_replace and/or value as regular expressions. If this is True then to_replace must be a string. Otherwise, to_replace must be None because this parameter will be interpreted as a regular expression or a list, dict, or array of regular expressions.
method: The method to use when for replacement, when to_replace is a list.

NDFrame.reindex NDFrame.asfreq NDFrame.fillna

filled : NDFrame

AssertionError

If regex is not a bool and to_replace is not None.

TypeError

If to_replace is a dict and value is not a list, dict, ndarray, or Series
If to_replace is None and regex is not compilable into a regular expression or is a list, dict, ndarray, or Series.

ValueError

If to_replace and value are list s or ndarray s, but they are not the same length.

Regex substitution is performed under the hood with re.sub. The rules for substitution for re.sub are the same.
Regular expressions will only substitute on strings, meaning you cannot provide, for example, a regular expression matching floating point numbers and expect the columns in your frame that have a numeric dtype to be matched. However, if those floating point numbers are strings, then you can do this.
This method has a lot of options. You are encouraged to experiment and play with this method to gain intuition about how it works.

reproject(spatial_reference, transformation=None, inplace=False)¶: Reprojects a given dataframe into a new coordinate system.

resample(rule, how=None, axis=0, fill_method=None, closed=None, label=None, convention='start', kind=None, loffset=None, limit=None, base=0)¶

Convenience method for frequency conversion and resampling of regular time-series data.

rule: the offset string or object representing target conversion

axis : int, optional, default 0 closed : {‘right’, ‘left’}

Which side of bin interval is closed

label: Which bin edge label to label bucket with

convention : {‘start’, ‘end’, ‘s’, ‘e’} loffset : timedelta

Adjust the resampled time labels

base: For frequencies that evenly subdivide 1 day, the “origin” of the aggregated intervals. For example, for ‘5min’ frequency, base could range from 0 through 4. Defaults to 0

Start by creating a series with 9 one minute timestamps.

>>> index = pd.date_range('1/1/2000', periods=9, freq='T')
>>> series = pd.Series(range(9), index=index)
>>> series
2000-01-01 00:00:00    0
2000-01-01 00:01:00    1
2000-01-01 00:02:00    2
2000-01-01 00:03:00    3
2000-01-01 00:04:00    4
2000-01-01 00:05:00    5
2000-01-01 00:06:00    6
2000-01-01 00:07:00    7
2000-01-01 00:08:00    8
Freq: T, dtype: int64

Downsample the series into 3 minute bins and sum the values of the timestamps falling into a bin.

>>> series.resample('3T').sum()
2000-01-01 00:00:00     3
2000-01-01 00:03:00    12
2000-01-01 00:06:00    21
Freq: 3T, dtype: int64

Downsample the series into 3 minute bins as above, but label each bin using the right edge instead of the left. Please note that the value in the bucket used as the label is not included in the bucket, which it labels. For example, in the original series the bucket 2000-01-01 00:03:00 contains the value 3, but the summed value in the resampled bucket with the label``2000-01-01 00:03:00`` does not include 3 (if it did, the summed value would be 6, not 3). To include this value close the right side of the bin interval as illustrated in the example below this one.

>>> series.resample('3T', label='right').sum()
2000-01-01 00:03:00     3
2000-01-01 00:06:00    12
2000-01-01 00:09:00    21
Freq: 3T, dtype: int64

Downsample the series into 3 minute bins as above, but close the right side of the bin interval.

>>> series.resample('3T', label='right', closed='right').sum()
2000-01-01 00:00:00     0
2000-01-01 00:03:00     6
2000-01-01 00:06:00    15
2000-01-01 00:09:00    15
Freq: 3T, dtype: int64

Upsample the series into 30 second bins.

>>> series.resample('30S').asfreq()[0:5] #select first 5 rows
2000-01-01 00:00:00     0
2000-01-01 00:00:30   NaN
2000-01-01 00:01:00     1
2000-01-01 00:01:30   NaN
2000-01-01 00:02:00     2
Freq: 30S, dtype: float64

Upsample the series into 30 second bins and fill the NaN values using the pad method.

>>> series.resample('30S').pad()[0:5]
2000-01-01 00:00:00    0
2000-01-01 00:00:30    0
2000-01-01 00:01:00    1
2000-01-01 00:01:30    1
2000-01-01 00:02:00    2
Freq: 30S, dtype: int64

Upsample the series into 30 second bins and fill the NaN values using the bfill method.

>>> series.resample('30S').bfill()[0:5]
2000-01-01 00:00:00    0
2000-01-01 00:00:30    1
2000-01-01 00:01:00    1
2000-01-01 00:01:30    2
2000-01-01 00:02:00    2
Freq: 30S, dtype: int64

Pass a custom function via apply

>>> def custom_resampler(array_like):
...     return np.sum(array_like)+5

>>> series.resample('3T').apply(custom_resampler)
2000-01-01 00:00:00     8
2000-01-01 00:03:00    17
2000-01-01 00:06:00    26
Freq: 3T, dtype: int64

reset_index(level=None, drop=False, inplace=False, col_level=0, col_fill='')¶

For DataFrame with multi-level index, return new DataFrame with labeling information in the columns under the index names, defaulting to ‘level_0’, ‘level_1’, etc. if any are None. For a standard index, the index name will be used (if set), otherwise a default ‘index’ or ‘level_0’ (if ‘index’ is already taken) will be used.

level: Only remove the given levels from the index. Removes all levels by default
drop: Do not try to insert index into dataframe columns. This resets the index to the default integer index.
inplace: Modify the DataFrame in place (do not create a new object)
col_level: If the columns have multiple levels, determines which level the labels are inserted into. By default it is inserted into the first level.
col_fill: If the columns have multiple levels, determines how the other levels are named. If None then the index name is repeated.

resetted : DataFrame

rfloordiv(other, axis='columns', level=None, fill_value=None)¶

Integer division of dataframe and other, element-wise (binary operator rfloordiv).

Equivalent to other // dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.floordiv

rmod(other, axis='columns', level=None, fill_value=None)¶

Modulo of dataframe and other, element-wise (binary operator rmod).

Equivalent to other % dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.mod

rmul(other, axis='columns', level=None, fill_value=None)¶

Multiplication of dataframe and other, element-wise (binary operator rmul).

Equivalent to other * dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.mul

rolling(window, min_periods=None, freq=None, center=False, win_type=None, axis=0)¶

Provides rolling transformations.

New in version 0.18.0.

window: Size of the moving window. This is the number of observations used for calculating the statistic.
min_periods: Minimum number of observations in window required to have a value (otherwise result is NA).
freq: Frequency to conform the data to before computing the statistic. Specified as a frequency string or DateOffset object.
center: Set the labels at the center of the window.
win_type: prove a window type, see the notes below

axis : int, default 0

a Window sub-classed for the particular operation

By default, the result is set to the right edge of the window. This can be changed to the center of the window by setting center=True.

The freq keyword is used to conform time series data to a specified frequency by resampling the data. This is done with the default parameters of resample() (i.e. using the mean).

The recognized window types are:

boxcar
triang
blackman
hamming
bartlett
parzen
bohman
blackmanharris
nuttall
barthann
kaiser (needs beta)
gaussian (needs std)
general_gaussian (needs power, width)
slepian (needs width).

round(decimals=0, *args, **kwargs)¶

Round a DataFrame to a variable number of decimal places.

New in version 0.17.0.

decimals: Number of decimal places to round each column to. If an int is given, round each column to the same number of places. Otherwise dict and Series round to variable numbers of places. Column names should be in the keys if decimals is a dict-like, or in the index if decimals is a Series. Any columns not included in decimals will be left as is. Elements of decimals which are not columns of the input will be ignored.

>>> df = pd.DataFrame(np.random.random([3, 3]),
...     columns=['A', 'B', 'C'], index=['first', 'second', 'third'])
>>> df
               A         B         C
first   0.028208  0.992815  0.173891
second  0.038683  0.645646  0.577595
third   0.877076  0.149370  0.491027
>>> df.round(2)
           A     B     C
first   0.03  0.99  0.17
second  0.04  0.65  0.58
third   0.88  0.15  0.49
>>> df.round({'A': 1, 'C': 2})
          A         B     C
first   0.0  0.992815  0.17
second  0.0  0.645646  0.58
third   0.9  0.149370  0.49
>>> decimals = pd.Series([1, 0, 2], index=['A', 'B', 'C'])
>>> df.round(decimals)
          A  B     C
first   0.0  1  0.17
second  0.0  1  0.58
third   0.9  0  0.49

DataFrame object

numpy.around Series.round

rpow(other, axis='columns', level=None, fill_value=None)¶

Exponential power of dataframe and other, element-wise (binary operator rpow).

Equivalent to other ** dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.pow

rsub(other, axis='columns', level=None, fill_value=None)¶

Subtraction of dataframe and other, element-wise (binary operator rsub).

Equivalent to other - dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.sub

rtruediv(other, axis='columns', level=None, fill_value=None)¶

Floating division of dataframe and other, element-wise (binary operator rtruediv).

Equivalent to other / dataframe, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.truediv

sample(n=None, frac=None, replace=False, weights=None, random_state=None, axis=None)¶

Returns a random sample of items from an axis of object.

New in version 0.16.1.

n: Number of items from axis to return. Cannot be used with frac. Default = 1 if frac = None.
frac: Fraction of axis items to return. Cannot be used with n.
replace: Sample with or without replacement. Default = False.
weights: Default ‘None’ results in equal probability weighting. If passed a Series, will align with target object on index. Index values in weights not found in sampled object will be ignored and index values in sampled object not in weights will be assigned weights of zero. If called on a DataFrame, will accept the name of a column when axis = 0. Unless weights are a Series, weights must be same length as axis being sampled. If weights do not sum to 1, they will be normalized to sum to 1. Missing values in the weights column will be treated as zero. inf and -inf values not allowed.
random_state: Seed for the random number generator (if int), or numpy RandomState object.
axis: Axis to sample. Accepts axis number or name. Default is stat axis for given data type (0 for Series and DataFrames, 1 for Panels).

A new object of same type as caller.

Generate an example Series and DataFrame:

>>> s = pd.Series(np.random.randn(50))
>>> s.head()
0   -0.038497
1    1.820773
2   -0.972766
3   -1.598270
4   -1.095526
dtype: float64
>>> df = pd.DataFrame(np.random.randn(50, 4), columns=list('ABCD'))
>>> df.head()
          A         B         C         D
0  0.016443 -2.318952 -0.566372 -1.028078
1 -1.051921  0.438836  0.658280 -0.175797
2 -1.243569 -0.364626 -0.215065  0.057736
3  1.768216  0.404512 -0.385604 -1.457834
4  1.072446 -1.137172  0.314194 -0.046661

Next extract a random sample from both of these objects...

3 random elements from the Series:

>>> s.sample(n=3)
27   -0.994689
55   -1.049016
67   -0.224565
dtype: float64

And a random 10% of the DataFrame with replacement:

>>> df.sample(frac=0.1, replace=True)
           A         B         C         D
1.981780  0.142106  1.817165 -0.290805
-1.336199 -0.448634 -0.789640  0.217116
0.823173 -0.078816  1.009536  1.015108
1.421154 -0.055301 -1.922594 -0.019696
-0.148339  0.832938  1.787600 -1.383767

segment_along_line(start_measure, end_measure, use_percentage=False)¶

Returns a Polyline between start and end measures. Similar to Polyline.positionAlongLine but will return a polyline segment between two points on the polyline instead of a single point.

Parameters:

start_measure:

The starting distance from the beginning of the

line.

end_measure:

The ending distance from the beginning of the

line.

use_percentage:

The start and end measures may be specified as

fixed units or as a ratio. If True, start_measure and end_measure are used as a percentage; if False, start_measure and end_measure are used as a distance. For percentages, the measures should be expressed as a double from 0.0 (0 percent) to 1.0 (100 percent).

select(crit, axis=0)¶

Return data corresponding to axis labels matching criteria

crit: To be called on each index (label). Should return True or False

axis : int

selection : type of caller

select_by_location(other, matches_only=True)¶

Selects all rows in a given SpatialDataFrame based on a given geometry

Inputs:: other: arcpy.Geometry object matches_only: boolean value, if true, only matched records will be

returned, else a field called ‘select_by_location’ will be added to the dataframe with the results of the select by location.

select_dtypes(include=None, exclude=None)¶

Return a subset of a DataFrame including/excluding columns based on their dtype.

include, exclude: A list of dtypes or strings to be included/excluded. You must pass in a non-empty sequence for at least one of these.

ValueError

If both of include and exclude are empty
If include and exclude have overlapping elements
If any kind of string dtype is passed in.

TypeError

If either of include or exclude is not a sequence

subset: The subset of the frame including the dtypes in include and excluding the dtypes in exclude.

To select all numeric types use the numpy dtype numpy.number
To select strings you must use the object dtype, but note that this will return all object dtype columns
See the numpy dtype hierarchy
To select Pandas categorical dtypes, use ‘category’

>>> df = pd.DataFrame({'a': np.random.randn(6).astype('f4'),
...                    'b': [True, False] * 3,
...                    'c': [1.0, 2.0] * 3})
>>> df
        a      b  c
0  0.3962   True  1
1  0.1459  False  2
2  0.2623   True  1
3  0.0764  False  2
4 -0.9703   True  1
5 -1.2094  False  2
>>> df.select_dtypes(include=['float64'])
   c
0  1
1  2
2  1
3  2
4  1
5  2
>>> df.select_dtypes(exclude=['floating'])
       b
0   True
1  False
2   True
3  False
4   True
5  False

sem(axis=None, skipna=None, level=None, ddof=1, numeric_only=None, **kwargs)¶

Return unbiased standard error of the mean over requested axis.

Normalized by N-1 by default. This can be changed using the ddof argument

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
ddof: degrees of freedom
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

sem : Series or DataFrame (if level specified)

series_extent¶

Return a single bounding box (xmin, ymin, xmax, ymax) for all geometries

This is a shortcut for calculating the min/max x and y bounds individually.

set_axis(axis, labels)¶: public verson of axis assignment

set_geometry(col, drop=False, inplace=False, sr=None)¶

Set the SpatialDataFrame geometry using either an existing column or the specified input. By default yields a new object.

The original geometry column is replaced with the input.

Parameters: keys: column label or array drop: boolean, default True

Delete column to be used as the new geometry

inplace: boolean, default False: Modify the SpatialDataFrame in place (do not create a new object)
sr: Coordinate system to use. If passed, overrides both DataFrame and col’s sr. Otherwise, tries to get sr from passed col values or DataFrame.

Returns: SpatialDataFrame

set_index(keys, drop=True, append=False, inplace=False, verify_integrity=False)¶

Set the DataFrame index (row labels) using one or more existing columns. By default yields a new object.

keys : column label or list of column labels / arrays drop : boolean, default True

Delete columns to be used as the new index

append: Whether to append columns to existing index
inplace: Modify the DataFrame in place (do not create a new object)
verify_integrity: Check the new index for duplicates. Otherwise defer the check until necessary. Setting to False will improve the performance of this method

>>> indexed_df = df.set_index(['A', 'B'])
>>> indexed_df2 = df.set_index(['A', [0, 1, 2, 0, 1, 2]])
>>> indexed_df3 = df.set_index([[0, 1, 2, 0, 1, 2]])

dataframe : DataFrame

set_value(index, col, value, takeable=False)¶

Put single value at passed column and index

index : row label col : column label value : scalar value takeable : interpret the index/col as indexers, default False

frame: If label pair is contained, will be reference to calling DataFrame, otherwise a new object

shape¶: Return a tuple representing the dimensionality of the DataFrame.

shift(periods=1, freq=None, axis=0)¶

Shift index by desired number of periods with an optional time freq

periods: Number of periods to move, can be positive or negative
freq: Increment to use from datetools module or time rule (e.g. ‘EOM’). See Notes.

axis : {0, 1, ‘index’, ‘columns’}

If freq is specified then the index values are shifted but the data is not realigned. That is, use freq if you would like to extend the index when shifting and preserve the original data.

shifted : DataFrame

sindex¶

size¶: number of elements in the NDFrame

skew(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return unbiased skew over requested axis Normalized by N-1

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

skew : Series or DataFrame (if level specified)

slice_shift(periods=1, axis=0)¶

Equivalent to shift without copying data. The shifted data will not include the dropped periods and the shifted axis will be smaller than the original.

periods: Number of periods to move, can be positive or negative

While the slice_shift is faster than shift, you may pay for it later during alignment.

shifted : same type as caller

snap_to_line(second_geometry)¶

Returns a new point based on in_point snapped to this geometry.

Paramters:

second_geometry:
	a second geometry

sort(columns=None, axis=0, ascending=True, inplace=False, kind='quicksort', na_position='last', **kwargs)¶

DEPRECATED: use DataFrame.sort_values()

Sort DataFrame either by labels (along either axis) or by the values in column(s)

columns: Column name(s) in frame. Accepts a column name or a list for a nested sort. A tuple will be interpreted as the levels of a multi-index.
ascending: Sort ascending vs. descending. Specify list for multiple sort orders
axis: Sort index/rows versus columns
inplace: Sort the DataFrame without creating a new instance
kind: This option is only applied when sorting on a single column or label.
na_position: ‘first’ puts NaNs at the beginning ‘last’ puts NaNs at the end

>>> result = df.sort(['A', 'B'], ascending=[1, 0])

sorted : DataFrame

sort_index(axis=0, level=None, ascending=True, inplace=False, kind='quicksort', na_position='last', sort_remaining=True, by=None)¶

Sort object by labels (along an axis)

axis : index, columns to direct sorting level : int or level name or list of ints or list of level names

if not None, sort on values in specified index level(s)

ascending: Sort ascending vs. descending
inplace: if True, perform operation in-place
kind: Choice of sorting algorithm. See also ndarray.np.sort for more information. mergesort is the only stable algorithm. For DataFrames, this option is only applied when sorting on a single column or label.
na_position: first puts NaNs at the beginning, last puts NaNs at the end
sort_remaining: if true and sorting by level and index is multilevel, sort by other levels too (in order) after sorting by specified level

sorted_obj : DataFrame

sort_values(by, axis=0, ascending=True, inplace=False, kind='quicksort', na_position='last')¶

Sort by the values along either axis

New in version 0.17.0.

by : string name or list of names which refer to the axis items axis : index, columns to direct sorting ascending : bool or list of bool

Sort ascending vs. descending. Specify list for multiple sort orders. If this is a list of bools, must match the length of the by.

inplace: if True, perform operation in-place
kind: Choice of sorting algorithm. See also ndarray.np.sort for more information. mergesort is the only stable algorithm. For DataFrames, this option is only applied when sorting on a single column or label.
na_position: first puts NaNs at the beginning, last puts NaNs at the end

sorted_obj : DataFrame

sortlevel(level=0, axis=0, ascending=True, inplace=False, sort_remaining=True)¶

Sort multilevel index by chosen axis and primary level. Data will be lexicographically sorted by the chosen level followed by the other levels (in order)

level : int axis : {0 or ‘index’, 1 or ‘columns’}, default 0 ascending : boolean, default True inplace : boolean, default False

Sort the DataFrame without creating a new instance

sort_remaining: Sort by the other levels too.

sorted : DataFrame

DataFrame.sort_index(level=...)

spatial_reference¶: The spatial reference of the geometry.

squeeze(**kwargs)¶: Squeeze length 1 dimensions.

stack(level=-1, dropna=True)¶

Pivot a level of the (possibly hierarchical) column labels, returning a DataFrame (or Series in the case of an object with a single level of column labels) having a hierarchical index with a new inner-most level of row labels. The level involved will automatically get sorted.

level: Level(s) to stack, can pass level name
dropna: Whether to drop rows in the resulting Frame/Series with no valid values

>>> s
     a   b
one  1.  2.
two  3.  4.

>>> s.stack()
one a    1
    b    2
two a    3
    b    4

stacked : DataFrame or Series

std(axis=None, skipna=None, level=None, ddof=1, numeric_only=None, **kwargs)¶

Return sample standard deviation over requested axis.

Normalized by N-1 by default. This can be changed using the ddof argument

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
ddof: degrees of freedom
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

std : Series or DataFrame (if level specified)

style¶

Property returning a Styler object containing methods for building a styled HTML representation fo the DataFrame.

pandas.formats.style.Styler

sub(other, axis='columns', level=None, fill_value=None)¶

Subtraction of dataframe and other, element-wise (binary operator sub).

Equivalent to dataframe - other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rsub

subtract(other, axis='columns', level=None, fill_value=None)¶

Subtraction of dataframe and other, element-wise (binary operator sub).

Equivalent to dataframe - other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rsub

sum(axis=None, skipna=None, level=None, numeric_only=None, **kwargs)¶

Return the sum of the values for the requested axis

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

sum : Series or DataFrame (if level specified)

swapaxes(axis1, axis2, copy=True)¶

Interchange axes and swap values axes appropriately

y : same as input

swaplevel(i=-2, j=-1, axis=0)¶

Swap levels i and j in a MultiIndex on a particular axis

i, j: Level of index to be swapped. Can pass level name as string.

swapped : type of caller (new object)

Changed in version 0.18.1: The indexes i and j are now optional, and default to the two innermost levels of the index.

symmetric_difference(second_geometry)¶

Constructs the geometry that is the union of two geometries minus the instersection of those geometries. The two input geometries must be the same shape type. Parameters:

second_geometry:

a second geometry

tail(n=5)¶: Returns last n rows

take(indices, axis=0, convert=True, is_copy=True, **kwargs)¶

Analogous to ndarray.take

indices : list / array of ints axis : int, default 0 convert : translate neg to pos indices (default) is_copy : mark the returned frame as a copy

taken : type of caller

to_clipboard(excel=None, sep=None, **kwargs)¶

Attempt to write text representation of object to the system clipboard This can be pasted into Excel, for example.

excel: if True, use the provided separator, writing in a csv format for allowing easy pasting into excel. if False, write a string representation of the object to the clipboard

sep : optional, defaults to tab other keywords are passed to to_csv

Requirements for your platform

Linux: xclip, or xsel (with gtk or PyQt4 modules)
Windows: none
OS X: none

to_csv(path_or_buf=None, sep=', ', na_rep='', float_format=None, columns=None, header=True, index=True, index_label=None, mode='w', encoding=None, compression=None, quoting=None, quotechar='"', line_terminator='\n', chunksize=None, tupleize_cols=False, date_format=None, doublequote=True, escapechar=None, decimal='.', **kwds)¶

Write DataFrame to a comma-separated values (csv) file

path_or_buf: File path or object, if None is provided the result is returned as a string.
sep: Field delimiter for the output file.
na_rep: Missing data representation
float_format: Format string for floating point numbers
columns: Columns to write
header: Write out column names. If a list of string is given it is assumed to be aliases for the column names
index: Write row names (index)
index_label: Column label for index column(s) if desired. If None is given, and header and index are True, then the index names are used. A sequence should be given if the DataFrame uses MultiIndex. If False do not print fields for index names. Use index_label=False for easier importing in R
nanRep: deprecated, use na_rep
mode: Python write mode, default ‘w’
encoding: A string representing the encoding to use in the output file, defaults to ‘ascii’ on Python 2 and ‘utf-8’ on Python 3.
compression: a string representing the compression to use in the output file, allowed values are ‘gzip’, ‘bz2’, ‘xz’, only used when the first argument is a filename
line_terminator: The newline character or character sequence to use in the output file
quoting: defaults to csv.QUOTE_MINIMAL
quotechar: character used to quote fields
doublequote: Control quoting of quotechar inside a field
escapechar: character used to escape sep and quotechar when appropriate
chunksize: rows to write at a time
tupleize_cols: write multi_index columns as a list of tuples (if True) or new (expanded format) if False)
date_format: Format string for datetime objects
decimal: string, default ‘.’: Character recognized as decimal separator. E.g. use ‘,’ for European data

New in version 0.16.0.

to_dense()¶: Return dense representation of NDFrame (as opposed to sparse)

to_dict(orient='dict')¶

Convert DataFrame to dictionary.

orient

:str {‘dict’, ‘list’, ‘series’, ‘split’, ‘records’, ‘index’}

Determines the type of the values of the dictionary.

dict (default) : dict like {column -> {index -> value}}
list : dict like {column -> [values]}
series : dict like {column -> Series(values)}
split : dict like {index -> [index], columns -> [columns], data -> [values]}
records : list like [{column -> value}, ... , {column -> value}]
index : dict like {index -> {column -> value}}

New in version 0.17.0.

Abbreviations are allowed. s indicates series and sp indicates split.

result : dict like {column -> {index -> value}}

to_excel(excel_writer, sheet_name='Sheet1', na_rep='', float_format=None, columns=None, header=True, index=True, index_label=None, startrow=0, startcol=0, engine=None, merge_cells=True, encoding=None, inf_rep='inf', verbose=True)¶

Write DataFrame to a excel sheet

excel_writer: File path or existing ExcelWriter
sheet_name: Name of sheet which will contain DataFrame
na_rep: Missing data representation
float_format: Format string for floating point numbers
columns: Columns to write
header: Write out column names. If a list of string is given it is assumed to be aliases for the column names
index: Write row names (index)
index_label: Column label for index column(s) if desired. If None is given, and header and index are True, then the index names are used. A sequence should be given if the DataFrame uses MultiIndex.
startrow :: upper left cell row to dump data frame
startcol :: upper left cell column to dump data frame
engine: write engine to use - you can also set this via the options io.excel.xlsx.writer, io.excel.xls.writer, and io.excel.xlsm.writer.
merge_cells: Write MultiIndex and Hierarchical Rows as merged cells.
encoding: string, default None: encoding of the resulting excel file. Only necessary for xlwt, other writers support unicode natively.
inf_rep: Representation for infinity (there is no native representation for infinity in Excel)

If passing an existing ExcelWriter object, then the sheet will be added to the existing workbook. This can be used to save different DataFrames to one workbook:

>>> writer = ExcelWriter('output.xlsx')
>>> df1.to_excel(writer,'Sheet1')
>>> df2.to_excel(writer,'Sheet2')
>>> writer.save()

For compatibility with to_csv, to_excel serializes lists and dicts to strings before writing.

to_featureclass(out_location, out_name, overwrite=True, skip_invalid=True)¶

converts a SpatialDataFrame to a feature class

Parameters:

out_location:	save location workspace
out_name:	name of the feature class to save as
overwrite:	boolean. True means to erase and replace value, false means to append
skip_invalids:	if True, any bad rows will be ignored.

Output:

tuple of feature class path and list of bad rows by index number.

to_featurelayer(title, gis=None, tags=None)¶: publishes a spatial dataframe to a new feature layer

to_featureset()¶: Converts a spatial dataframe to a feature set object

to_gbq(destination_table, project_id, chunksize=10000, verbose=True, reauth=False, if_exists='fail', private_key=None)¶

Write a DataFrame to a Google BigQuery table.

THIS IS AN EXPERIMENTAL LIBRARY

dataframe: DataFrame to be written
destination_table: Name of table to be written, in the form ‘dataset.tablename’
project_id: Google BigQuery Account project ID.
chunksize: Number of rows to be inserted in each chunk from the dataframe.
verbose: Show percentage complete
reauth: Force Google BigQuery to reauthenticate the user. This is useful if multiple accounts are used.
if_exists: ‘fail’: If table exists, do nothing. ‘replace’: If table exists, drop it, recreate it, and insert data. ‘append’: If table exists, insert data. Create if does not exist.
private_key: Service account private key in JSON format. Can be file path or string contents. This is useful for remote server authentication (eg. jupyter iPython notebook on remote host)

New in version 0.17.0.

to_hdf(path_or_buf, key, **kwargs)¶

Write the contained data to an HDF5 file using HDFStore.

path_or_buf : the path (string) or HDFStore object key : string

indentifier for the group in the store

mode : optional, {‘a’, ‘w’, ‘r+’}, default ‘a’

'w'

Write; a new file is created (an existing file with the same name would be deleted).

'a'

Append; an existing file is opened for reading and writing, and if the file does not exist it is created.

'r+'

It is similar to 'a', but the file must already exist.

format

:‘fixed(f)|table(t)’, default is ‘fixed’

fixed(f): Fast writing/reading. Not-appendable, nor searchable
table(t): Write as a PyTables Table structure which may perform worse but allow more flexible operations like searching / selecting subsets of the data

append

:boolean, default FalseFor Table formats, append the input data to the existing

data_columns

:list of columns, or True, default None

List of columns to create as indexed data columns for on-disk queries, or True to use all columns. By default only the axes of the object are indexed. See here.

Applicable only to format=’table’.

complevel

:int, 1-9, default 0If a complib is specified compression will be applied where possible

complib

:{‘zlib’, ‘bzip2’, ‘lzo’, ‘blosc’, None}, default NoneIf complevel is > 0 apply compression to objects written in the store wherever possible

fletcher32

:bool, default FalseIf applying compression use the fletcher32 checksum

dropna

:boolean, default False.If true, ALL nan rows will not be written to store.

to_html(buf=None, columns=None, col_space=None, colSpace=None, header=True, index=True, na_rep='NaN', formatters=None, float_format=None, sparsify=None, index_names=True, justify=None, bold_rows=True, classes=None, escape=True, max_rows=None, max_cols=None, show_dimensions=False, notebook=False, decimal='.')¶

Render a DataFrame as an HTML table.

to_html-specific options:

bold_rows: Make the row labels bold in the output
classes: CSS class(es) to apply to the resulting html table
escape: Convert the characters <, >, and & to HTML-safe sequences.=
max_rows: Maximum number of rows to show before truncating. If None, show all.
max_cols: Maximum number of columns to show before truncating. If None, show all.
decimal: Character recognized as decimal separator, e.g. ‘,’ in Europe

New in version 0.18.0.

buf: buffer to write to
columns: the subset of columns to write; default None writes all columns
col_space: the minimum width of each column
header: whether to print column labels, default True
index: whether to print index (row) labels, default True
na_rep: string representation of NAN to use, default ‘NaN’
formatters: formatter functions to apply to columns’ elements by position or name, default None. The result of each function must be a unicode string. List must be of length equal to the number of columns.
float_format: formatter function to apply to columns’ elements if they are floats, default None. The result of this function must be a unicode string.
sparsify: Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row, default True
index_names: Prints the names of the indexes, default True
justify: Left or right-justify the column labels. If None uses the option from the print configuration (controlled by set_option), ‘right’ out of the box.

formatted : string (or unicode, depending on data and options)

to_json(path_or_buf=None, orient=None, date_format='epoch', double_precision=10, force_ascii=True, date_unit='ms', default_handler=None)¶

Convert the object to a JSON string.

Note NaN’s and None will be converted to null and datetime objects will be converted to UNIX timestamps.

path_or_buf: if this is None, return a StringIO of the converted string

orient : string

Series

default is ‘index’

allowed values are: {‘split’,’records’,’index’}

DataFrame

default is ‘columns’

allowed values are: {‘split’,’records’,’index’,’columns’,’values’}

The format of the JSON string

split : dict like {index -> [index], columns -> [columns], data -> [values]}

records : list like [{column -> value}, ... , {column -> value}]

index : dict like {index -> {column -> value}}

columns : dict like {column -> {index -> value}}

values : just the values array

date_format: Type of date conversion. epoch = epoch milliseconds, iso` = ISO8601, default is epoch.
double_precision: floating point values, default 10.

force_ascii : force encoded string to be ASCII, default True. date_unit : string, default ‘ms’ (milliseconds)

The time unit to encode to, governs timestamp and ISO8601 precision. One of ‘s’, ‘ms’, ‘us’, ‘ns’ for second, millisecond, microsecond, and nanosecond respectively.

default_handler: Handler to call if object cannot otherwise be converted to a suitable format for JSON. Should receive a single argument which is the object to convert and return a serialisable object.

same type as input object with filtered info axis

to_latex(buf=None, columns=None, col_space=None, colSpace=None, header=True, index=True, na_rep='NaN', formatters=None, float_format=None, sparsify=None, index_names=True, bold_rows=True, column_format=None, longtable=None, escape=None, encoding=None, decimal='.')¶

Render a DataFrame to a tabular environment table. You can splice this into a LaTeX document. Requires usepackage{booktabs}.

to_latex-specific options:

bold_rows: Make the row labels bold in the output
column_format: The columns format as specified in LaTeX table format e.g ‘rcl’ for 3 columns
longtable: default: False Use a longtable environment instead of tabular. Requires adding a usepackage{longtable} to your LaTeX preamble.
escape: default: True When set to False prevents from escaping latex special characters in column names.
encoding: Default encoding is ascii in Python 2 and utf-8 in Python 3
decimal: Character recognized as decimal separator, e.g. ‘,’ in Europe

New in version 0.18.0.

buf: buffer to write to
columns: the subset of columns to write; default None writes all columns
col_space: the minimum width of each column
header: whether to print column labels, default True
index: whether to print index (row) labels, default True
na_rep: string representation of NAN to use, default ‘NaN’
formatters: formatter functions to apply to columns’ elements by position or name, default None. The result of each function must be a unicode string. List must be of length equal to the number of columns.
float_format: formatter function to apply to columns’ elements if they are floats, default None. The result of this function must be a unicode string.
sparsify: Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row, default True
index_names: Prints the names of the indexes, default True

formatted : string (or unicode, depending on data and options)

to_msgpack(path_or_buf=None, encoding='utf-8', **kwargs)¶

msgpack (serialize) object to input file path

THIS IS AN EXPERIMENTAL LIBRARY and the storage format may not be stable until a future release.

path: if None, return generated string
append: (default is False)
compress: compression)

to_panel()¶

Transform long (stacked) format (DataFrame) into wide (3D, Panel) format.

Currently the index of the DataFrame must be a 2-level MultiIndex. This may be generalized later

panel : Panel

to_period(freq=None, axis=0, copy=True)¶

Convert DataFrame from DatetimeIndex to PeriodIndex with desired frequency (inferred from index if not passed)

freq : string, default axis : {0 or ‘index’, 1 or ‘columns’}, default 0

The axis to convert (the index by default)

copy: If False then underlying input data is not copied

ts : TimeSeries with PeriodIndex

to_pickle(path)¶

Pickle (serialize) object to input file path.

path: File path

to_records(index=True, convert_datetime64=True)¶

Convert DataFrame to record array. Index will be put in the ‘index’ field of the record array if requested

index: Include index in resulting record array, stored in ‘index’ field
convert_datetime64: Whether to convert the index to datetime.datetime if it is a DatetimeIndex

y : recarray

to_sparse(fill_value=None, kind='block')¶

Convert to SparseDataFrame

fill_value : float, default NaN kind : {‘block’, ‘integer’}

y : SparseDataFrame

to_sql(name, con, flavor='sqlite', schema=None, if_exists='fail', index=True, index_label=None, chunksize=None, dtype=None)¶

Write records stored in a DataFrame to a SQL database.

name

:stringName of SQL table

con

:SQLAlchemy engine or DBAPI2 connection (legacy mode)Using SQLAlchemy makes it possible to use any DB supported by that library. If a DBAPI2 object, only sqlite3 is supported.

flavor

:{‘sqlite’, ‘mysql’}, default ‘sqlite’The flavor of SQL to use. Ignored when using SQLAlchemy engine. ‘mysql’ is deprecated and will be removed in future versions, but it will be further supported through SQLAlchemy engines.

schema

:string, default NoneSpecify the schema (if database flavor supports this). If None, use default schema.

if_exists

:{‘fail’, ‘replace’, ‘append’}, default ‘fail’

fail: If table exists, do nothing.
replace: If table exists, drop it, recreate it, and insert data.
append: If table exists, insert data. Create if does not exist.

index

:boolean, default TrueWrite DataFrame index as a column.

index_label

:string or sequence, default NoneColumn label for index column(s). If None is given (default) and index is True, then the index names are used. A sequence should be given if the DataFrame uses MultiIndex.

chunksize

:int, default NoneIf not None, then rows will be written in batches of this size at a time. If None, all rows will be written at once.

dtype

:dict of column name to SQL type, default NoneOptional specifying the datatype for columns. The SQL type should be a SQLAlchemy type, or a string for sqlite3 fallback connection.

to_stata(fname, convert_dates=None, write_index=True, encoding='latin-1', byteorder=None, time_stamp=None, data_label=None)¶

A class for writing Stata binary dta files from array-like objects

fname: Where to save the dta file.
convert_dates: Dictionary mapping column of datetime types to the stata internal format that you want to use for the dates. Options are ‘tc’, ‘td’, ‘tm’, ‘tw’, ‘th’, ‘tq’, ‘ty’. Column can be either a number or a name.
encoding: Default is latin-1. Note that Stata does not support unicode.
byteorder: Can be “>”, “<”, “little”, or “big”. The default is None which uses sys.byteorder

>>> writer = StataWriter('./data_file.dta', data)
>>> writer.write_file()

Or with dates

>>> writer = StataWriter('./date_data_file.dta', data, {2 : 'tw'})
>>> writer.write_file()

to_string(buf=None, columns=None, col_space=None, header=True, index=True, na_rep='NaN', formatters=None, float_format=None, sparsify=None, index_names=True, justify=None, line_width=None, max_rows=None, max_cols=None, show_dimensions=False)¶

Render a DataFrame to a console-friendly tabular output.

buf: buffer to write to
columns: the subset of columns to write; default None writes all columns
col_space: the minimum width of each column
header: whether to print column labels, default True
index: whether to print index (row) labels, default True
na_rep: string representation of NAN to use, default ‘NaN’
formatters: formatter functions to apply to columns’ elements by position or name, default None. The result of each function must be a unicode string. List must be of length equal to the number of columns.
float_format: formatter function to apply to columns’ elements if they are floats, default None. The result of this function must be a unicode string.
sparsify: Set to False for a DataFrame with a hierarchical index to print every multiindex key at each row, default True
index_names: Prints the names of the indexes, default True
justify: Left or right-justify the column labels. If None uses the option from the print configuration (controlled by set_option), ‘right’ out of the box.

formatted : string (or unicode, depending on data and options)

to_timestamp(freq=None, how='start', axis=0, copy=True)¶

Cast to DatetimeIndex of timestamps, at beginning of period

freq: Desired frequency
how: Convention for converting period to timestamp; start of period vs. end
axis: The axis to convert (the index by default)
copy: If false then underlying input data is not copied

df : DataFrame with DatetimeIndex

to_wide(*args, **kwargs)¶

to_xarray()¶

Return an xarray object from the pandas object.

a DataArray for a Series a Dataset for a DataFrame a DataArray for higher dims

>>> df = pd.DataFrame({'A' : [1, 1, 2],
                       'B' : ['foo', 'bar', 'foo'],
                       'C' : np.arange(4.,7)})
>>> df
   A    B    C
0  1  foo  4.0
1  1  bar  5.0
2  2  foo  6.0

>>> df.to_xarray()
<xarray.Dataset>
Dimensions:  (index: 3)
Coordinates:
  * index    (index) int64 0 1 2
Data variables:
    A        (index) int64 1 1 2
    B        (index) object 'foo' 'bar' 'foo'
    C        (index) float64 4.0 5.0 6.0

>>> df = pd.DataFrame({'A' : [1, 1, 2],
                       'B' : ['foo', 'bar', 'foo'],
                       'C' : np.arange(4.,7)}
                     ).set_index(['B','A'])
>>> df
         C
B   A
foo 1  4.0
bar 1  5.0
foo 2  6.0

>>> df.to_xarray()
<xarray.Dataset>
Dimensions:  (A: 2, B: 2)
Coordinates:
  * B        (B) object 'bar' 'foo'
  * A        (A) int64 1 2
Data variables:
    C        (B, A) float64 5.0 nan 4.0 6.0

>>> p = pd.Panel(np.arange(24).reshape(4,3,2),
                 items=list('ABCD'),
                 major_axis=pd.date_range('20130101', periods=3),
                 minor_axis=['first', 'second'])
>>> p
<class 'pandas.core.panel.Panel'>
Dimensions: 4 (items) x 3 (major_axis) x 2 (minor_axis)
Items axis: A to D
Major_axis axis: 2013-01-01 00:00:00 to 2013-01-03 00:00:00
Minor_axis axis: first to second

>>> p.to_xarray()
<xarray.DataArray (items: 4, major_axis: 3, minor_axis: 2)>
array([[[ 0,  1],
        [ 2,  3],
        [ 4,  5]],
       [[ 6,  7],
        [ 8,  9],
        [10, 11]],
       [[12, 13],
        [14, 15],
        [16, 17]],
       [[18, 19],
        [20, 21],
        [22, 23]]])
Coordinates:
  * items       (items) object 'A' 'B' 'C' 'D'
  * major_axis  (major_axis) datetime64[ns] 2013-01-01 2013-01-02 2013-01-03  # noqa
  * minor_axis  (minor_axis) object 'first' 'second'

See the xarray docs

touches(second_geometry)¶

Indicates if the boundaries of the geometries intersect.

Paramters:

second_geometry:
	a second geometry

transpose(*args, **kwargs)¶: Transpose index and columns

true_centroid¶: The center of gravity for a feature.

truediv(other, axis='columns', level=None, fill_value=None)¶

Floating division of dataframe and other, element-wise (binary operator truediv).

Equivalent to dataframe / other, but with support to substitute a fill_value for missing data in one of the inputs.

other : Series, DataFrame, or constant axis : {0, 1, ‘index’, ‘columns’}

For Series input, axis to match Series index on

fill_value: Fill missing (NaN) values with this value. If both DataFrame locations are missing, the result will be missing
level: Broadcast across a level, matching Index values on the passed MultiIndex level

Mismatched indices will be unioned together

result : DataFrame

DataFrame.rtruediv

truncate(before=None, after=None, axis=None, copy=True)¶

Truncates a sorted NDFrame before and/or after some particular dates.

before: Truncate before date
after: Truncate after date

axis : the truncation axis, defaults to the stat axis copy : boolean, default is True,

return a copy of the truncated section

truncated : type of caller

tshift(periods=1, freq=None, axis=0)¶

Shift the time index, using the index’s frequency if available.

periods: Number of periods to move, can be positive or negative
freq: Increment to use from datetools module or time rule (e.g. ‘EOM’)
axis: Corresponds to the axis that contains the Index

If freq is not specified then tries to use the freq or inferred_freq attributes of the index. If neither of those attributes exist, a ValueError is thrown

shifted : NDFrame

tz_convert(tz, axis=0, level=None, copy=True)¶

Convert tz-aware axis to target time zone.

tz : string or pytz.timezone object axis : the axis to convert level : int, str, default None

If axis ia a MultiIndex, convert a specific level. Otherwise must be None

copy: Also make a copy of the underlying data

TypeError: If the axis is tz-naive.

tz_localize(tz, axis=0, level=None, copy=True, ambiguous='raise')¶

Localize tz-naive TimeSeries to target time zone.

tz : string or pytz.timezone object axis : the axis to localize level : int, str, default None

If axis ia a MultiIndex, localize a specific level. Otherwise must be None

copy

:boolean, default TrueAlso make a copy of the underlying data

ambiguous

:‘infer’, bool-ndarray, ‘NaT’, default ‘raise’

‘infer’ will attempt to infer fall dst-transition hours based on order
bool-ndarray where True signifies a DST time, False designates a non-DST time (note that this flag is only applicable for ambiguous times)
‘NaT’ will return NaT where there are ambiguous times
‘raise’ will raise an AmbiguousTimeError if there are ambiguous times

infer_dst

:boolean, default False (DEPRECATED)Attempt to infer fall dst-transition hours based on order

TypeError: If the TimeSeries is tz-aware and tz is not None.

union(second_geometry)¶

Constructs the geometry that is the set-theoretic union of the input geometries.

Paramters:

second_geometry:
	a second geometry

unstack(level=-1, fill_value=None)¶

Pivot a level of the (necessarily hierarchical) index labels, returning a DataFrame having a new level of column labels whose inner-most level consists of the pivoted index labels. If the index is not a MultiIndex, the output will be a Series (the analogue of stack when the columns are not a MultiIndex). The level involved will automatically get sorted.

level: Level(s) of index to unstack, can pass level name
fill_value: missing values

DataFrame.pivot : Pivot a table based on column values. DataFrame.stack : Pivot a level of the column labels (inverse operation

from unstack).

>>> index = pd.MultiIndex.from_tuples([('one', 'a'), ('one', 'b'),
...                                    ('two', 'a'), ('two', 'b')])
>>> s = pd.Series(np.arange(1.0, 5.0), index=index)
>>> s
one  a   1
     b   2
two  a   3
     b   4
dtype: float64

>>> s.unstack(level=-1)
     a   b
one  1  2
two  3  4

>>> s.unstack(level=0)
   one  two
a  1   3
b  2   4

>>> df = s.unstack(level=0)
>>> df.unstack()
one  a  1.
     b  3.
two  a  2.
     b  4.

unstacked : DataFrame or Series

update(other, join='left', overwrite=True, filter_func=None, raise_conflict=False)¶

Modify DataFrame in place using non-NA values from passed DataFrame. Aligns on indices

other : DataFrame, or object coercible into a DataFrame join : {‘left’}, default ‘left’ overwrite : boolean, default True

If True then overwrite values for common keys in the calling frame

filter_func: Can choose to replace values other than NA. Return True for values that should be updated
raise_conflict: If True, will raise an error if the DataFrame and other both contain data in the same place.

values¶

Numpy representation of NDFrame

The dtype will be a lower-common-denominator dtype (implicit upcasting); that is to say if the dtypes (even of numeric types) are mixed, the one that accommodates all will be chosen. Use this with care if you are not dealing with the blocks.

e.g. If the dtypes are float16 and float32, dtype will be upcast to float32. If dtypes are int32 and uint8, dtype will be upcase to int32.

var(axis=None, skipna=None, level=None, ddof=1, numeric_only=None, **kwargs)¶

Return unbiased variance over requested axis.

Normalized by N-1 by default. This can be changed using the ddof argument

axis : {index (0), columns (1)} skipna : boolean, default True

Exclude NA/null values. If an entire row/column is NA, the result will be NA

level: If the axis is a MultiIndex (hierarchical), count along a particular level, collapsing into a Series
ddof: degrees of freedom
numeric_only: Include only float, int, boolean data. If None, will attempt to use everything, then use only numeric data

var : Series or DataFrame (if level specified)

where(cond, other=nan, inplace=False, axis=None, level=None, try_cast=False, raise_on_error=True)¶

Return an object of same shape as self and whose corresponding entries are from self where cond is True and otherwise are from other.

cond

:boolean NDFrame, array or callable

If cond is callable, it is computed on the NDFrame and should return boolean NDFrame or array. The callable must not change input NDFrame (though pandas doesn’t check it).

New in version 0.18.1.

A callable can be used as cond.

other

:scalar, NDFrame, or callable

If other is callable, it is computed on the NDFrame and should return scalar or NDFrame. The callable must not change input NDFrame (though pandas doesn’t check it).

New in version 0.18.1.

A callable can be used as other.

inplace

:boolean, default FalseWhether to perform the operation in place on the data

axis : alignment axis if needed, default None level : alignment level if needed, default None try_cast : boolean, default False

try to cast the result back to the input type (if possible),

raise_on_error: Whether to raise on invalid data types (e.g. trying to where on strings)

wh : same type as caller

within(second_geometry, relation=None)¶

Indicates if the base geometry is within the comparison geometry. Paramters:

second_geometry:

a second geometry

relation:

The spatial relationship type.

BOUNDARY - Relationship has no restrictions for interiors or boundaries. CLEMENTINI - Interiors of geometries must intersect. Specifying

CLEMENTINI is equivalent to specifying None. This is the default.

PROPER - Boundaries of geometries must not intersect.

xs(key, axis=0, level=None, copy=None, drop_level=True)¶

Returns a cross-section (row(s) or column(s)) from the Series/DataFrame. Defaults to cross-section on the rows (axis=0).

key: Some label contained in the index, or partially in a MultiIndex
axis: Axis to retrieve cross-section on
level: In case of a key partially contained in a MultiIndex, indicate which levels are used. Levels can be referred by label or position.
copy: Whether to make a copy of the data
drop_level: If False, returns object with same levels as self.

>>> df
   A  B  C
a  4  5  2
b  4  0  9
c  9  7  3
>>> df.xs('a')
A    4
B    5
C    2
Name: a
>>> df.xs('C', axis=1)
a    2
b    9
c    3
Name: C

>>> df
                    A  B  C  D
first second third
bar   one    1      4  1  8  9
      two    1      7  5  5  0
baz   one    1      6  6  8  0
      three  2      5  3  5  3
>>> df.xs(('baz', 'three'))
       A  B  C  D
third
2      5  3  5  3
>>> df.xs('one', level=1)
             A  B  C  D
first third
bar   1      4  1  8  9
baz   1      6  6  8  0
>>> df.xs(('baz', 2), level=[0, 'third'])
        A  B  C  D
second
three   5  3  5  3

xs : Series or DataFrame

xs is only for getting, not setting values.

MultiIndex Slicers is a generic way to get/set values on any level or levels. It is a superset of xs functionality, see MultiIndex Slicers