NOTICE

The upcoming release of Featuretools 1.0.0 contains several breaking changes. Users are encouraged to test this version prior to release:

pip install featuretools==1.0.0rc1

For details on migrating to the new version, refer to Transitioning to Featuretools Version 1.0. Please report any issues in the Featuretools GitHub repo or by messaging in Alteryx Open Source Slack.


featuretools.primitives.Haversine

class featuretools.primitives.Haversine(unit='miles')[source]

Calculates the approximate haversine distance between two LatLong variable types.

Parameters

unit (str) – Determines the unit value to output. Could be miles or kilometers. Default is miles.

Examples

>>> haversine = Haversine()
>>> distances = haversine([(42.4, -71.1), (40.0, -122.4)],
...                       [(40.0, -122.4), (41.2, -96.75)])
>>> np.round(distances, 3).tolist()
[2631.231, 1343.289]

Output units can be specified

>>> haversine_km = Haversine(unit='kilometers')
>>> distances_km = haversine_km([(42.4, -71.1), (40.0, -122.4)],
...                             [(40.0, -122.4), (41.2, -96.75)])
>>> np.round(distances_km, 3).tolist()
[4234.555, 2161.814]
__init__(unit='miles')[source]

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

Methods

__init__([unit])

Initialize self.

generate_name(base_feature_names)

generate_names(base_feature_names)

get_args_string()

get_arguments()

get_description(input_column_descriptions[, …])

get_filepath(filename)

get_function()

Attributes

base_of

base_of_exclude

commutative

compatibility

default_value

description_template

input_types

max_stack_depth

name

number_output_features

uses_calc_time

uses_full_entity