pycontrails.core.flight¶
Flight Data Handling.
Module Attributes
Max airport elevation, [\(ft\)] See Daocheng_Yading_Airport |
|
Min estimated cruise altitude, [\(ft\)] |
|
Short haul duration cutoff, [\(s\)] |
|
Set maximum speed compatible with "on_ground" indicator, [\(mph\)] Thresholds assessed based on scatter plot (150 knots = 278 km/h) |
Functions
|
Filter noisy altitude on a single flight. |
|
Calculate the time difference between waypoints. |
|
Identify the phase of flight (climb, cruise, descent) for each segment. |
|
Calculate the rate of climb and descent (ROCD). |
Classes
|
A single flight trajectory. |
|
Flight phase enumeration. |
- class pycontrails.core.flight.Flight(data=None, *, longitude=None, latitude=None, altitude=None, altitude_ft=None, level=None, time=None, attrs=None, copy=True, fuel=None, drop_duplicated_times=False, **attrs_kwargs)¶
Bases:
GeoVectorDataset
A single flight trajectory.
Expect latitude-longitude coordinates in WGS 84. Expect altitude in [\(m\)]. Expect pressure level (level) in [\(hPa\)].
- Parameters:
data (
dict[str
,np.ndarray] | pd.DataFrame | VectorDataDict | VectorDataset | None
) – Flight trajectory waypoints as data dictionary orpandas.DataFrame
. Must include columnstime
,latitude
,longitude
,altitude
orlevel
. Keyword arguments fortime
,latitude
,longitude
,altitude
orlevel
will overridedata
inputs. Expectsaltitude
in meters andtime
as a DatetimeLike (or array that can processed withpd.to_datetime()
). Additional waypoint-specific data can be included as additional keys/columns.longitude (
npt.ArrayLike
, optional) – Flight trajectory waypoint longitude. Defaults to None.latitude (
npt.ArrayLike
, optional) – Flight trajectory waypoint latitude. Defaults to None.altitude (
npt.ArrayLike
, optional) – Flight trajectory waypoint altitude, [\(m\)]. Defaults to None.altitude_ft (
npt.ArrayLike
, optional) – Flight trajectory waypoint altitude, [\(ft\)].level (
npt.ArrayLike
, optional) – Flight trajectory waypoint pressure level, [\(hPa\)]. Defaults to None.time (
npt.ArrayLike
, optional) – Flight trajectory waypoint time. Defaults to None.attrs (
dict[str
,Any]
, optional) – Additional flight properties as a dictionary. While different models may utilize Flight attributes differently, pycontrails applies the following conventions:flight_id
: An internal flight identifier. Used internally forFleet
interoperability.aircraft_type
: Aircraft type ICAO, e.g."A320"
.wingspan
: Aircraft wingspan, [\(m\)].n_engine
: Number of aircraft engines.engine_uid
: Aircraft engine unique identifier. Used for emissions calculations with the ICAO Aircraft Emissions Databank (EDB).max_mach_number
: Maximum Mach number at cruise altitude. Used by some aircraft performance models to clip true airspeed.load_factor
: The load factor used in determining the aircraft’s take-off weight. Used by some aircraft performance models.
Numeric quantities that are constant over the entire flight trajectory should be included as attributes.
copy (
bool
, optional) – Copy data on Flight creation. Defaults to True.fuel (
Fuel
, optional) – Fuel used in flight trajectory. Defaults toJetA
.drop_duplicated_times (
bool
, optional) – Drop duplicate times in flight trajectory. Defaults to False.**attrs_kwargs (
Any
) – Additional flight properties passed as keyword arguments.
- Raises:
KeyError – Raises if
data
input does not contain at leasttime
,latitude
,longitude
, (altitude
orlevel
).
Notes
The Traffic library has many helpful flight processing utilities.
See
traffic.core.Flight
for more information.Examples
>>> import numpy as np >>> import pandas as pd >>> from pycontrails import Flight
>>> # Create `Flight` from a DataFrame. >>> df = pd.DataFrame({ ... "longitude": np.linspace(20, 30, 500), ... "latitude": np.linspace(40, 10, 500), ... "altitude": 10500, ... "time": pd.date_range('2021-01-01T10', '2021-01-01T15', periods=500), ... }) >>> fl = Flight(data=df, flight_id=123) # specify a flight_id by keyword >>> fl Flight [4 keys x 500 length, 1 attributes] Keys: longitude, latitude, altitude, time Attributes: time [2021-01-01 10:00:00, 2021-01-01 15:00:00] longitude [20.0, 30.0] latitude [10.0, 40.0] altitude [10500.0, 10500.0] flight_id 123
>>> # Create `Flight` from keywords >>> fl = Flight( ... longitude=np.linspace(20, 30, 200), ... latitude=np.linspace(40, 30, 200), ... altitude=11000 * np.ones(200), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200), ... ) >>> fl Flight [4 keys x 200 length, 0 attributes] Keys: longitude, latitude, time, altitude Attributes: time [2021-01-01 12:00:00, 2021-01-01 14:00:00] longitude [20.0, 30.0] latitude [30.0, 40.0] altitude [11000.0, 11000.0]
>>> # Access the underlying data as DataFrame >>> fl.dataframe.head() longitude latitude time altitude 0 20.000000 40.000000 2021-01-01 12:00:00.000000000 11000.0 1 20.050251 39.949749 2021-01-01 12:00:36.180904522 11000.0 2 20.100503 39.899497 2021-01-01 12:01:12.361809045 11000.0 3 20.150754 39.849246 2021-01-01 12:01:48.542713567 11000.0 4 20.201005 39.798995 2021-01-01 12:02:24.723618090 11000.0
- T_isa()¶
Calculate the ICAO standard atmosphere temperature at each point.
- Returns:
npt.NDArray[np.float64]
– ISA temperature, [\(K\)]
- property air_pressure¶
Get
air_pressure
values for points.- Returns:
npt.NDArray[np.float64]
– Point air pressure values, [\(Pa\)]
- property altitude¶
Get altitude.
Automatically calculates altitude using
units.pl_to_m()
usinglevel
key.Note that if
altitude
key exists indata
, the data at thealtitude
key will be returned. This allows an override of the default calculation of altitude from pressure level.- Returns:
npt.NDArray[np.float64]
– Altitude, [\(m\)]
- property altitude_ft¶
Get altitude in feet.
- Returns:
npt.NDArray[np.float64]
– Altitude, [\(ft\)]
- attrs¶
Generic dataset attributes
- broadcast_attrs(keys, overwrite=False, raise_error=True)¶
Attach values from
keys
inattrs
ontodata
.If possible, use
dtype = np.float32
when broadcasting. If not possible, use whateverdtype
is inferred from the data bynumpy.full()
.
- broadcast_numeric_attrs(ignore_keys=None, overwrite=False)¶
Attach numeric values in
attrs
ontodata
.Iterate through values in
attrs
and attachfloat
andint
values todata
.This method modifies object in place.
- clean_and_resample(freq='1min', fill_method='geodesic', geodesic_threshold=100000.0, nominal_rocd=12.7, kernel_size=17, cruise_threshold=120.0, force_filter=False, drop=True, keep_original_index=False, climb_descend_at_end=False)¶
Resample and (possibly) filter a flight trajectory.
Waypoints are resampled according to the frequency
freq
. If the original flight data has a short sampling period, filter_altitude will also be called to clean the data. Large gaps in trajectories may be interpolated as step climbs through _altitude_interpolation.- Parameters:
freq (
str
, optional) – Resampling frequency, by default “1min”fill_method (
{"geodesic", "linear"}
, optional) – Choose between"geodesic"
and"linear"
, by default"geodesic"
. In geodesic mode, large gaps between waypoints are filled with geodesic interpolation and small gaps are filled with linear interpolation. In linear mode, all gaps are filled with linear interpolation.geodesic_threshold (
float
, optional) – Threshold for geodesic interpolation, [\(m\)]. If the distance between consecutive waypoints is under this threshold, values are interpolated linearly.nominal_rocd (
float
, optional) – Nominal rate of climb / descent for aircraft type. Defaults toconstants.nominal_rocd
.kernel_size (
int
, optional) – Passed directly toscipy.signal.medfilt()
, by default 11. Passed also toscipy.signal.medfilt()
cruise_theshold (
float
, optional) – Minimal length of time, in seconds, for a flight to be in cruise to apply median filterforce_filter (
bool
, optional) – If set to true, meth:filter_altitude will always be called. otherwise, it will only be called if the flight has a median sample period under 10 secondsdrop (
bool
, optional) – Drop any columns that are not resampled and filled. Defaults toTrue
, dropping all keys outside of “time”, “latitude”, “longitude” and “altitude”. If set to False, the extra keys will be kept but filled withnan
orNone
values, depending on the data type.keep_original_index (
bool
, optional) – Keep the original index of theFlight
in addition to the new resampled index. Defaults toFalse
. .. versionadded:: 0.45.2climb_or_descend_at_end (
bool
) – If true, the climb or descent will be placed at the end of each segment rather than the start. Default is false (climb or descent immediately).
- Returns:
Flight
– Filled Flight
- property constants¶
Return a dictionary of constant attributes and data values.
Includes
attrs
and values from columns indata
with a unique value.- Returns:
dict[str
,Any]
– Properties and their constant values
- property coords¶
Get geospatial coordinates for compatibility with MetDataArray.
- Returns:
pandas.DataFrame
–pd.DataFrame
with columns longitude, latitude, level, and time.
- coords_intersect_met(met)¶
Return boolean mask of data inside the bounding box defined by
met
.- Parameters:
met (
MetDataset | MetDataArray
) – MetDataset or MetDataArray to compare.- Returns:
npt.NDArray[np.bool_]
– True if point is inside the bounding box defined bymet
.
- copy(**kwargs)¶
Return a copy of this instance.
- Parameters:
**kwargs (
Any
) – Additional keyword arguments passed into the constructor of the returned class.- Returns:
Self
– Copy of class
- classmethod create_empty(keys=None, attrs=None, **attrs_kwargs)¶
Create instance with variables defined by
keys
and size 0.If instance requires additional variables to be defined, these keys will automatically be attached to returned instance.
- Parameters:
keys (
Iterable[str]
) – Keys to include in empty VectorDataset instance.attrs (
dict[str
,Any] | None
, optional) – Attributes to attach instance.**attrs_kwargs (
Any
) – Define attributes as keyword arguments.
- Returns:
Self
– Empty VectorDataset instance.
- data¶
Vector data with labels as keys and
numpy.ndarray
as values
- property dataframe¶
Shorthand property to access
to_dataframe()
withcopy=False
.- Returns:
pandas.DataFrame
– Equivalent to the output fromto_dataframe()
- distance_to_coords(distance)¶
Convert distance along flight path to geodesic coordinates.
Will return a tuple containing (lat, lon, index), where index indicates which flight segment contains the returned coordinate.
- Parameters:
distance (
ArrayOrFloat
) – Distance along flight path, [\(m\)]- Returns:
(ArrayOrFloat
,ArrayOrFloat
,int | npt.NDArray[int])
– latitude, longitude, and segment index cooresponding to distance.
- downselect_met(met, *, longitude_buffer=(0.0, 0.0), latitude_buffer=(0.0, 0.0), level_buffer=(0.0, 0.0), time_buffer=(np.timedelta64(0, 'h'), np.timedelta64(0, 'h')), copy=True)¶
Downselect
met
to encompass a spatiotemporal region of the data.- Parameters:
met (
MetDataset | MetDataArray
) – MetDataset or MetDataArray to downselect.longitude_buffer (
tuple[float
,float]
, optional) – Extend longitude domain past bylongitude_buffer[0]
on the low side andlongitude_buffer[1]
on the high side. Units must be the same as class coordinates. Defaults to(0, 0)
degrees.latitude_buffer (
tuple[float
,float]
, optional) – Extend latitude domain past bylatitude_buffer[0]
on the low side andlatitude_buffer[1]
on the high side. Units must be the same as class coordinates. Defaults to(0, 0)
degrees.level_buffer (
tuple[float
,float]
, optional) – Extend level domain past bylevel_buffer[0]
on the low side andlevel_buffer[1]
on the high side. Units must be the same as class coordinates. Defaults to(0, 0)
[\(hPa\)].time_buffer (
tuple[np.timedelta64
,np.timedelta64]
, optional) – Extend time domain past bytime_buffer[0]
on the low side andtime_buffer[1]
on the high side. Units must be the same as class coordinates. Defaults to(np.timedelta64(0, "h"), np.timedelta64(0, "h"))
.copy (
bool
) – If returned object is a copy or view of the original. True by default.
- Returns:
MetDataset | MetDataArray
– Copy of downselected MetDataset or MetDataArray.
- property duration¶
Determine flight duration.
- Returns:
pd.Timedelta
– Difference between terminal and initial time
- ensure_vars(vars, raise_error=True)¶
Ensure variables exist in column of
data
orattrs
.- Parameters:
vars (
str | Iterable[str]
) – A single string variable name or a sequence of string variable names.raise_error (
bool
, optional) – Raise KeyError if data does not contain variables. Defaults to True.
- Returns:
bool
– True if all variables exist. False otherwise.- Raises:
KeyError – Raises when dataset does not contain variable in
vars
- filter(mask, copy=True, **kwargs)¶
Filter
data
according to a boolean arraymask
.Entries corresponding to
mask == True
are kept.- Parameters:
mask (
npt.NDArray[np.bool_]
) – Boolean array with compatible shape.copy (
bool
, optional) – Copy data on filter. Defaults to True. See numpy best practices for insight into whether copy is appropriate.**kwargs (
Any
) – Additional keyword arguments passed into the constructor of the returned class.
- Returns:
Self
– Containing filtered data- Raises:
TypeError – If
mask
is not a boolean array.
- filter_altitude(kernel_size=17, cruise_threshold=120.0)¶
Filter noisy altitude on a single flight.
Currently runs altitude through a median filter using
scipy.signal.medfilt()
withkernel_size
, then a Savitzky-Golay filter to filter noise. The median filter is only applied during cruise segments that are longer thancruise_threshold
.- Parameters:
kernel_size (
int
, optional) – Passed directly toscipy.signal.medfilt()
, by default 11. Passed also toscipy.signal.medfilt()
cruise_theshold (
float
, optional) – Minimal length of time, in seconds, for a flight to be in cruise to apply median filter
- Returns:
Flight
– Filtered Flight
Notes
Algorithm is derived from
traffic.core.Flight.filter()
.The traffic algorithm also computes thresholds on sliding windows and replaces unacceptable values with NaNs.
Errors may raised if the
kernel_size
is too large.See also
traffic.core.flight.Flight.filter()
,scipy.signal.medfilt()
- filter_by_first()¶
Keep first row of group of waypoints with identical coordinates.
Chaining this method with resample_and_fill often gives a cleaner trajectory when using noisy flight waypoints.
- Returns:
Flight
– Filtered Flight instance
Examples
>>> from datetime import datetime >>> import pandas as pd
>>> df = pd.DataFrame() >>> df['longitude'] = [0, 0, 50] >>> df['latitude'] = 0 >>> df['altitude'] = 0 >>> df['time'] = [datetime(2020, 1, 1, h) for h in range(3)]
>>> fl = Flight(df)
>>> fl.filter_by_first().dataframe longitude latitude altitude time 0 0.0 0.0 0.0 2020-01-01 00:00:00 1 50.0 0.0 0.0 2020-01-01 02:00:00
- classmethod from_dict(obj, copy=True, **obj_kwargs)¶
Create instance from dict representation containing data and attrs.
- Parameters:
- Returns:
Self
– VectorDataset instance.
See also
- fuel¶
Fuel used in flight trajectory
- generate_splits(n_splits, copy=True)¶
Split instance into
n_split
sub-vectors.- Parameters:
n_splits (
int
) – Number of splits.copy (
bool
, optional) – Passed intofilter()
. Defaults to True. Recommend to keep as True based on numpy best practices.
- Returns:
Generator[Self
,None
,None]
– Generator of split vectors.
See also
- get(key, default_value=None)¶
- get_data_or_attr(key, default=<object object>)¶
-
This method first checks if
key
is indata
and returns the value if so. Ifkey
is not indata
, then this method checks ifkey
is inattrs
and returns the value if so. Ifkey
is not indata
orattrs
, then thedefault
value is returned if provided. Otherwise aKeyError
is raised.- Parameters:
- Returns:
Any
– Value atdata[key]
orattrs[key]
- Raises:
KeyError – If
key
is not indata
orattrs
anddefault
is not provided.
Examples
>>> vector = VectorDataset({"a": [1, 2, 3]}, attrs={"b": 4}) >>> vector.get_data_or_attr("a") array([1, 2, 3])
>>> vector.get_data_or_attr("b") 4
>>> vector.get_data_or_attr("c") Traceback (most recent call last): ... KeyError: "Key 'c' not found in data or attrs."
>>> vector.get_data_or_attr("c", default=5) 5
- property hash¶
Generate a unique hash for this class instance.
- Returns:
str
– Unique hash for flight instance (sha1)
- intersect_met(mda, *, longitude=None, latitude=None, level=None, time=None, use_indices=False, **interp_kwargs)¶
Intersect waypoints with MetDataArray.
- Parameters:
mda (
MetDataArray
) – MetDataArray containing a meteorological variable at spatio-temporal coordinates.longitude (
npt.NDArray[np.float64]
, optional) – Override existing coordinates for met interpolationlatitude (
npt.NDArray[np.float64]
, optional) – Override existing coordinates for met interpolationlevel (
npt.NDArray[np.float64]
, optional) – Override existing coordinates for met interpolationtime (
npt.NDArray[np.datetime64]
, optional) – Override existing coordinates for met interpolationuse_indices (
bool
, optional) – Experimental.**interp_kwargs (
Any
) – Additional keyword arguments to pass toMetDataArray.intersect_met()
. Examples includemethod
,bounds_error
, andfill_value
. If an error such asValueError: One of the requested xi is out of bounds in dimension 2
occurs, try calling this function with
bounds_error=False
. In addition, settingfill_value=0.0
will replace NaN values with 0.0.
- Returns:
npt.NDArray[np.float64]
– Interpolated values
Examples
>>> from datetime import datetime >>> import pandas as pd >>> import numpy as np >>> from pycontrails.datalib.ecmwf import ERA5 >>> from pycontrails import Flight
>>> # Get met data >>> times = (datetime(2022, 3, 1, 0), datetime(2022, 3, 1, 3)) >>> variables = ["air_temperature", "specific_humidity"] >>> levels = [300, 250, 200] >>> era5 = ERA5(time=times, variables=variables, pressure_levels=levels) >>> met = era5.open_metdataset()
>>> # Example flight >>> df = pd.DataFrame() >>> df['longitude'] = np.linspace(0, 50, 10) >>> df['latitude'] = np.linspace(0, 10, 10) >>> df['altitude'] = 11000 >>> df['time'] = pd.date_range("2022-03-01T00", "2022-03-01T02", periods=10) >>> fl = Flight(df)
>>> # Intersect >>> fl.intersect_met(met['air_temperature'], method='nearest') array([231.62969892, 230.72604651, 232.24318771, 231.88338483, 231.06429438, 231.59073409, 231.65125393, 231.93064004, 232.03344087, 231.65954432])
>>> fl.intersect_met(met['air_temperature'], method='linear') array([225.77794552, 225.13908414, 226.231218 , 226.31831528, 225.56102321, 225.81192149, 226.03192642, 226.22056121, 226.03770174, 225.63226188])
>>> # Interpolate and attach to `Flight` instance >>> for key in met: ... fl[key] = fl.intersect_met(met[key])
>>> # Show the final three columns of the dataframe >>> fl.dataframe.iloc[:, -3:].head() time air_temperature specific_humidity 0 2022-03-01 00:00:00 225.777946 0.000132 1 2022-03-01 00:13:20 225.139084 0.000132 2 2022-03-01 00:26:40 226.231218 0.000107 3 2022-03-01 00:40:00 226.318315 0.000171 4 2022-03-01 00:53:20 225.561022 0.000109
- property length¶
Return flight length based on WGS84 geodesic.
- Returns:
float
– Total flight length, [\(m\)]
Examples
>>> import numpy as np >>> fl = Flight( ... longitude=np.linspace(20, 30, 200), ... latitude=np.linspace(40, 30, 200), ... altitude=11000 * np.ones(200), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200), ... ) >>> fl.length np.float64(1436924.67...)
- length_met(key, threshold=1.0)¶
Calculate total horizontal distance where column
key
exceedsthreshold
.- Parameters:
- Returns:
float
– Total distance, [\(m\)]- Raises:
Examples
>>> from datetime import datetime >>> import pandas as pd >>> import numpy as np >>> from pycontrails.datalib.ecmwf import ERA5 >>> from pycontrails import Flight
>>> # Get met data >>> times = (datetime(2022, 3, 1, 0), datetime(2022, 3, 1, 3)) >>> variables = ["air_temperature", "specific_humidity"] >>> levels = [300, 250, 200] >>> era5 = ERA5(time=times, variables=variables, pressure_levels=levels) >>> met = era5.open_metdataset()
>>> # Build flight >>> df = pd.DataFrame() >>> df["time"] = pd.date_range("2022-03-01T00", "2022-03-01T03", periods=11) >>> df["longitude"] = np.linspace(-20, 20, 11) >>> df["latitude"] = np.linspace(-20, 20, 11) >>> df["altitude"] = np.linspace(9500, 10000, 11) >>> fl = Flight(df).resample_and_fill("10s")
>>> # Intersect and attach >>> fl["air_temperature"] = fl.intersect_met(met["air_temperature"]) >>> fl["air_temperature"] array([235.94657007, 235.55745645, 235.56709768, ..., 234.59917962, 234.60387402, 234.60845312])
>>> # Length (in meters) of waypoints whose temperature exceeds 236K >>> fl.length_met("air_temperature", threshold=236) np.float64(3589705.998...)
>>> # Proportion (with respect to distance) of waypoints whose temperature exceeds 236K >>> fl.proportion_met("air_temperature", threshold=236) np.float64(0.576...)
- property level¶
Get pressure
level
values for points.Automatically calculates pressure level using
units.m_to_pl()
usingaltitude
key.Note that if
level
key exists indata
, the data at thelevel
key will be returned. This allows an override of the default calculation of pressure level from altitude.- Returns:
npt.NDArray[np.float64]
– Point pressure level values, [\(hPa\)]
- property max_distance_gap¶
Return maximum distance gap between waypoints along flight trajectory.
Distance is calculated based on WGS84 geodesic.
- Returns:
float
– Maximum distance between waypoints, [\(m\)]
Examples
>>> import numpy as np >>> fl = Flight( ... longitude=np.linspace(20, 30, 200), ... latitude=np.linspace(40, 30, 200), ... altitude=11000 * np.ones(200), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200), ... ) >>> fl.max_distance_gap np.float64(7391.27...)
- property max_time_gap¶
Return maximum time gap between waypoints along flight trajectory.
- Returns:
pd.Timedelta
– Gap size
Examples
>>> import numpy as np >>> fl = Flight( ... longitude=np.linspace(20, 30, 200), ... latitude=np.linspace(40, 30, 200), ... altitude=11000 * np.ones(200), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=200), ... ) >>> fl.max_time_gap Timedelta('0 days 00:00:36.180...')
- plot(**kwargs)¶
Plot flight trajectory longitude-latitude values.
- Parameters:
**kwargs (
Any
) – Additional plot properties to passed to pd.DataFrame.plot- Returns:
matplotlib.axes.Axes
– Plot
- plot_profile(**kwargs)¶
Plot flight trajectory time-altitude values.
- Parameters:
**kwargs (
Any
) – Additional plot properties to passed to pd.DataFrame.plot- Returns:
matplotlib.axes.Axes
– Plot
- proportion_met(key, threshold=1.0)¶
Calculate proportion of flight with certain meteorological constraint.
- required_keys = ('longitude', 'latitude', 'time')¶
Required keys for creating GeoVectorDataset
- resample_and_fill(freq='1min', fill_method='geodesic', geodesic_threshold=100000.0, nominal_rocd=12.7, drop=True, keep_original_index=False, climb_descend_at_end=False)¶
Resample and fill flight trajectory with geodesics and linear interpolation.
Waypoints are resampled according to the frequency
freq
. Values fordata
columnslongitude
,latitude
, andaltitude
are interpolated.Resampled waypoints will include all multiples of
freq
between the flight start and end time. For example, when resampling to a frequency of 1 minute, a flight that starts at 2020/1/1 00:00:59 and ends at 2020/1/1 00:01:01 will return a single waypoint at 2020/1/1 00:01:00, whereas a flight that starts at 2020/1/1 00:01:01 and ends at 2020/1/1 00:01:59 will return an empty flight.- Parameters:
freq (
str
, optional) – Resampling frequency, by default “1min”fill_method (
{"geodesic", "linear"}
, optional) – Choose between"geodesic"
and"linear"
, by default"geodesic"
. In geodesic mode, large gaps between waypoints are filled with geodesic interpolation and small gaps are filled with linear interpolation. In linear mode, all gaps are filled with linear interpolation.geodesic_threshold (
float
, optional) – Threshold for geodesic interpolation, [\(m\)]. If the distance between consecutive waypoints is under this threshold, values are interpolated linearly.nominal_rocd (
float | None
, optional) – Nominal rate of climb / descent for aircraft type. Defaults toconstants.nominal_rocd
.drop (
bool
, optional) – Drop any columns that are not resampled and filled. Defaults toTrue
, dropping all keys outside of “time”, “latitude”, “longitude” and “altitude”. If set to False, the extra keys will be kept but filled withnan
orNone
values, depending on the data type.keep_original_index (
bool
, optional) – Keep the original index of theFlight
in addition to the new resampled index. Defaults toFalse
. .. versionadded:: 0.45.2climb_or_descend_at_end (
bool
) – If true, the climb or descent will be placed at the end of each segment rather than the start. Default is false (climb or descent immediately).
- Returns:
Flight
– Filled Flight- Raises:
ValueError – Unknown
fill_method
Examples
>>> from datetime import datetime >>> import pandas as pd
>>> df = pd.DataFrame() >>> df['longitude'] = [0, 0, 50] >>> df['latitude'] = 0 >>> df['altitude'] = 0 >>> df['time'] = [datetime(2020, 1, 1, h) for h in range(3)]
>>> fl = Flight(df) >>> fl.dataframe longitude latitude altitude time 0 0.0 0.0 0.0 2020-01-01 00:00:00 1 0.0 0.0 0.0 2020-01-01 01:00:00 2 50.0 0.0 0.0 2020-01-01 02:00:00
>>> fl.resample_and_fill('10min').dataframe # resample with 10 minute frequency longitude latitude altitude time 0 0.000000 0.0 0.0 2020-01-01 00:00:00 1 0.000000 0.0 0.0 2020-01-01 00:10:00 2 0.000000 0.0 0.0 2020-01-01 00:20:00 3 0.000000 0.0 0.0 2020-01-01 00:30:00 4 0.000000 0.0 0.0 2020-01-01 00:40:00 5 0.000000 0.0 0.0 2020-01-01 00:50:00 6 0.000000 0.0 0.0 2020-01-01 01:00:00 7 8.333333 0.0 0.0 2020-01-01 01:10:00 8 16.666667 0.0 0.0 2020-01-01 01:20:00 9 25.000000 0.0 0.0 2020-01-01 01:30:00 10 33.333333 0.0 0.0 2020-01-01 01:40:00 11 41.666667 0.0 0.0 2020-01-01 01:50:00 12 50.000000 0.0 0.0 2020-01-01 02:00:00
- segment_angle()¶
Calculate sine and cosine for the angle between each segment and the longitudinal axis.
This is different from the usual navigational angle between two points known as bearing.
Bearing in 3D spherical coordinates is referred to as azimuth.
(lon_2, lat_2) X /| / | / | / | / | / | / | (lon_1, lat_1) X -------> longitude (x-axis)
- Returns:
npt.NDArray[np.float64]
,npt.NDArray[np.float64]
– Returnssin(a), cos(a)
, wherea
is the angle between the segment and the longitudinal axis. The final values are of both arrays arenp.nan
.
See also
geo.segment_angle()
,units.heading_to_longitudinal_angle()
,segment_azimuth()
,geo.forward_azimuth()
Examples
>>> from pycontrails import Flight >>> fl = Flight( ... longitude=np.array([1, 2, 3, 5, 8]), ... latitude=np.arange(5), ... altitude=np.full(shape=(5,), fill_value=11000), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=5), ... ) >>> sin, cos = fl.segment_angle() >>> sin array([0.70716063, 0.70737598, 0.44819424, 0.31820671, nan])
>>> cos array([0.70705293, 0.70683748, 0.8939362 , 0.94802136, nan])
- segment_azimuth()¶
Calculate (forward) azimuth at each waypoint.
Method calls pyproj.Geod.inv, which is slow. See geo.forward_azimuth for an outline of a faster implementation.
Changed in version 0.33.7: The dtype of the output now matches the dtype of
self["longitude"]
.- Returns:
npt.NDArray[np.float64]
– Array of azimuths.
See also
segment_angle()
,geo.forward_azimuth()
- segment_duration(dtype=<class 'numpy.float32'>)¶
Compute time elapsed between waypoints in seconds.
np.nan
appended so the length of the output is the same as number of waypoints.- Parameters:
dtype (
np.dtype
) – Numpy dtype for time difference. Defaults tonp.float64
- Returns:
npt.NDArray[np.float64]
– Time difference between waypoints, [\(s\)]. Returns an array with dtype specified by``dtype``
- segment_groundspeed(smooth=False, window_length=7, polyorder=1)¶
Return groundspeed across segments.
Calculate by dividing the horizontal segment length by the difference in waypoint times.
- Parameters:
smooth (
bool
, optional) – Smooth airspeed with Savitzky-Golay filter. Defaults to False.window_length (
int
, optional) – Passed directly toscipy.signal.savgol_filter()
, by default 7.polyorder (
int
, optional) – Passed directly toscipy.signal.savgol_filter()
, by default 1.
- Returns:
npt.NDArray[np.float64]
– Groundspeed of the segment, [\(m s^{-1}\)]
- segment_haversine()¶
Compute Haversine (great circle) distance between flight waypoints.
Helper function used in
resample_and_fill()
. np.nan appended so the length of the output is the same as number of waypoints.To account for vertical displacements when computing segment lengths, use
segment_length()
.- Returns:
npt.NDArray[np.float64]
– Array of great circle distances in [\(m\)] between waypoints
Examples
>>> from pycontrails import Flight >>> fl = Flight( ... longitude=np.array([1, 2, 3, 5, 8]), ... latitude=np.arange(5), ... altitude=np.full(shape=(5,), fill_value=11000), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=5), ... ) >>> fl.segment_haversine() array([157255.03346286, 157231.08336815, 248456.48781503, 351047.44358851, nan])
See also
- segment_length()¶
Compute spherical distance between flight waypoints.
Helper function used in
length()
andlength_met()
. np.nan appended so the length of the output is the same as number of waypoints.- Returns:
npt.NDArray[np.float64]
– Array of distances in [\(m\)] between waypoints
Examples
>>> from pycontrails import Flight >>> fl = Flight( ... longitude=np.array([1, 2, 3, 5, 8]), ... latitude=np.arange(5), ... altitude=np.full(shape=(5,), fill_value=11000), ... time=pd.date_range('2021-01-01T12', '2021-01-01T14', periods=5), ... ) >>> fl.segment_length() array([157255.03346286, 157231.08336815, 248456.48781503, 351047.44358851, nan])
See also
- segment_mach_number(true_airspeed, air_temperature)¶
Calculate the mach number of each segment.
- Parameters:
true_airspeed (
npt.NDArray[np.float64]
) – True airspeed of the segment, [\(m \ s^{-1}\)]. Seesegment_true_airspeed()
.air_temperature (
npt.NDArray[np.float64]
) – Average air temperature of each segment, [\(K\)]
- Returns:
npt.NDArray[np.float64]
– Mach number of each segment
- segment_phase(threshold_rocd=250.0, min_cruise_altitude_ft=20000.0, air_temperature=None)¶
Identify the phase of flight (climb, cruise, descent) for each segment.
- Parameters:
threshold_rocd (
float
, optional) – ROCD threshold to identify climb and descent, [\(ft min^{-1}\)]. Currently set to 250 ft/min.min_cruise_altitude_ft (
float
, optional) – Minimum altitude for cruise, [\(ft\)] This is specific for each aircraft type, and can be approximated as 50% of the altitude ceiling. Defaults to 20000 ft.air_temperature (
None | npt.NDArray[np.float64]
) – Air temperature of each flight waypoint, [\(K\)]
- Returns:
npt.NDArray[np.uint8]
– Array of values enumerating the flight phase. Seeflight.FlightPhase
for enumeration.
See also
- segment_rocd(air_temperature=None)¶
Calculate the rate of climb and descent (ROCD).
- Parameters:
air_temperature (
None | npt.NDArray[np.float64]
) – Air temperature of each flight waypoint, [\(K\)]- Returns:
npt.NDArray[np.float64]
– Rate of climb and descent over segment, [\(ft min^{-1}\)]
See also
- segment_true_airspeed(u_wind=0.0, v_wind=0.0, smooth=True, window_length=7, polyorder=1)¶
Calculate the true airspeed [\(m/s\)] from the ground speed and horizontal winds.
The calculated ground speed will first be smoothed with a Savitzky-Golay filter if enabled.
- Parameters:
u_wind (
npt.NDArray[np.float64] | float
) – U wind speed, [\(m \ s^{-1}\)]. Defaults to 0 for all waypoints.v_wind (
npt.NDArray[np.float64] | float
) – V wind speed, [\(m \ s^{-1}\)]. Defaults to 0 for all waypoints.smooth (
bool
, optional) – Smooth airspeed with Savitzky-Golay filter. Defaults to True.window_length (
int
, optional) – Passed directly toscipy.signal.savgol_filter()
, by default 7.polyorder (
int
, optional) – Passed directly toscipy.signal.savgol_filter()
, by default 1.
- Returns:
npt.NDArray[np.float64]
– True wind speed of each segment, [\(m \ s^{-1}\)]
- select(keys, copy=True)¶
Return new class instance only containing specified keys.
- Parameters:
keys (
Iterable[str]
) – An iterable of keys to filter by.copy (
bool
, optional) – Copy data on selection. Defaults to True.
- Returns:
VectorDataset
– VectorDataset containing only data associated tokeys
. Note that this method always returns aVectorDataset
, even if the calling class is a proper subclass ofVectorDataset
.
- setdefault(key, default=None)¶
Shortcut to
VectorDataDict.setdefault()
.- Parameters:
- Returns:
numpy.ndarray
– Values atkey
- sort(by)¶
Sort data by key(s).
This method always creates a copy of the data by calling
pandas.DataFrame.sort_values()
.- Parameters:
by (
str | list[str]
) – Key or list of keys to sort by.- Returns:
Self
– Instance with sorted data.
- classmethod sum(vectors, infer_attrs=True, fill_value=None)¶
Sum a list of
VectorDataset
instances.- Parameters:
vectors (
Sequence[VectorDataset]
) – List ofVectorDataset
instances to concatenate.infer_attrs (
bool
, optional) – If True, infer attributes from the first element in the sequence.fill_value (
float
, optional) – Fill value to use when concatenating arrays. By default None, which raises an error if incompatible keys are found.
- Returns:
VectorDataset
– Sum of all instances invectors
.- Raises:
KeyError – If incompatible
data
keys are found amongvectors
.
Examples
>>> from pycontrails import VectorDataset >>> v1 = VectorDataset({"a": [1, 2, 3], "b": [4, 5, 6]}) >>> v2 = VectorDataset({"a": [7, 8, 9], "b": [10, 11, 12]}) >>> v3 = VectorDataset({"a": [13, 14, 15], "b": [16, 17, 18]}) >>> v = VectorDataset.sum([v1, v2, v3]) >>> v.dataframe a b 0 1 4 1 2 5 2 3 6 3 7 10 4 8 11 5 9 12 6 13 16 7 14 17 8 15 18
- property time_end¶
Last waypoint time.
- Returns:
pandas.Timestamp
– Last waypoint time
- property time_start¶
First waypoint time.
- Returns:
pandas.Timestamp
– First waypoint time
- to_dataframe(copy=True)¶
Create
pd.DataFrame
in which each key-value pair indata
is a column.DataFrame does not copy data by default. Use the
copy
parameter to copy data values on creation.- Parameters:
copy (
bool
, optional) – Copy data on DataFrame creation.- Returns:
pandas.DataFrame
– DataFrame holding key-values as columns.
- to_dict()¶
Create dictionary with
data
andattrs
.If geo-spatial coordinates (e.g.
"latitude"
,"longitude"
,"altitude"
) are present, round to a reasonable precision. If a"time"
variable is present, round to unix seconds. When the instance is aGeoVectorDataset
, disregard any"altitude"
or"level"
coordinate and only include"altitude_ft"
in the output.See also
Examples
>>> import pprint >>> from pycontrails import Flight >>> fl = Flight( ... longitude=[-100, -110], ... latitude=[40, 50], ... level=[200, 200], ... time=[np.datetime64("2020-01-01T09"), np.datetime64("2020-01-01T09:30")], ... aircraft_type="B737", ... ) >>> fl = fl.resample_and_fill("5min") >>> pprint.pprint(fl.to_dict()) {'aircraft_type': 'B737', 'altitude_ft': [38661.0, 38661.0, 38661.0, 38661.0, 38661.0, 38661.0, 38661.0], 'latitude': [40.0, 41.724, 43.428, 45.111, 46.769, 48.399, 50.0], 'longitude': [-100.0, -101.441, -102.959, -104.563, -106.267, -108.076, -110.0], 'time': [1577869200, 1577869500, 1577869800, 1577870100, 1577870400, 1577870700, 1577871000]}
- to_geojson_linestring()¶
Return trajectory as geojson FeatureCollection containing single LineString.
- Returns:
dict[str
,Any]
– Python representation of geojson FeatureCollection
- to_geojson_multilinestring(key=None, split_antimeridian=True)¶
Return trajectory as GeoJSON FeatureCollection of MultiLineStrings.
If key is provided, Flight
data
is grouped according to values ofkey
. Each group gives rise to a Feature containing a MultiLineString geometry. Each MultiLineString can optionally be split over the antimeridian.
- to_geojson_points()¶
Return dataset as GeoJSON FeatureCollection of Points.
Each Feature has a properties attribute that includes
time
and other data besideslatitude
,longitude
, andaltitude
indata
.- Returns:
dict[str
,Any]
– Python representation of GeoJSON FeatureCollection
- to_lon_lat_grid(agg, *, spatial_bbox=(-180.0, -90.0, 180.0, 90.0), spatial_grid_res=0.5)¶
Convert vectors to a longitude-latitude grid.
See also
vector_to_lon_lat_grid
- to_traffic()¶
Convert to :class:`traffic.core.Flight`instance.
- Returns:
traffic.core.Flight
– traffic flight instance- Raises:
ModuleNotFoundError – traffic package not installed
See also
- transform_crs(crs)¶
Transform trajectory data from one coordinate reference system (CRS) to another.
- update(other=None, **kwargs)¶
Update values in
data
dict without warning if overwriting.- Parameters:
other (
dict[str
,npt.ArrayLike] | None
, optional) – Fields to update as dict**kwargs (
npt.ArrayLike
) – Fields to update as kwargs
- vertical_keys = ('altitude', 'level', 'altitude_ft')¶
At least one of these vertical-coordinate keys must also be included
- class pycontrails.core.flight.FlightPhase(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
IntEnum
Flight phase enumeration.
Use
segment_phase()
orFlight.segment_phase()
to determine flight phase.- CLIMB = 1¶
Waypoints at which the flight is in a climb phase
- CRUISE = 2¶
Waypoints at which the flight is in a cruise phase
- DESCENT = 3¶
Waypoints at which the flight is in a descent phase
- LEVEL_FLIGHT = 4¶
Waypoints at which the flight is not in a climb, cruise, or descent phase. In practice, this category is used for waypoints at which the ROCD resembles that of a cruise phase, but the altitude is below the minimum cruise altitude.
- NAN = 5¶
Waypoints at which the ROCD is not defined.
- as_integer_ratio()¶
Return a pair of integers, whose ratio is equal to the original int.
The ratio is in lowest terms and has a positive denominator.
>>> (10).as_integer_ratio() (10, 1) >>> (-10).as_integer_ratio() (-10, 1) >>> (0).as_integer_ratio() (0, 1)
- bit_count()¶
Number of ones in the binary representation of the absolute value of self.
Also known as the population count.
>>> bin(13) '0b1101' >>> (13).bit_count() 3
- bit_length()¶
Number of bits necessary to represent self in binary.
>>> bin(37) '0b100101' >>> (37).bit_length() 6
- conjugate()¶
Returns self, the complex conjugate of any int.
- denominator¶
the denominator of a rational number in lowest terms
- from_bytes(byteorder='big', *, signed=False)¶
Return the integer represented by the given array of bytes.
- bytes
Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Indicates whether two’s complement is used to represent the integer.
- imag¶
the imaginary part of a complex number
- is_integer()¶
Returns True. Exists for duck type compatibility with float.is_integer.
- numerator¶
the numerator of a rational number in lowest terms
- real¶
the real part of a complex number
- to_bytes(length=1, byteorder='big', *, signed=False)¶
Return an array of bytes representing an integer.
- length
Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
- byteorder
The byte order used to represent the integer. If byteorder is ‘big’, the most significant byte is at the beginning of the byte array. If byteorder is ‘little’, the most significant byte is at the end of the byte array. To request the native byte order of the host system, use sys.byteorder as the byte order value. Default is to use ‘big’.
- signed
Determines whether two’s complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.
- pycontrails.core.flight.MAX_AIRPORT_ELEVATION = 15000.0¶
Max airport elevation, [\(ft\)] See Daocheng_Yading_Airport
- pycontrails.core.flight.MAX_ON_GROUND_SPEED = 150.0¶
Set maximum speed compatible with “on_ground” indicator, [\(mph\)] Thresholds assessed based on scatter plot (150 knots = 278 km/h)
- pycontrails.core.flight.MIN_CRUISE_ALTITUDE = 20000.0¶
Min estimated cruise altitude, [\(ft\)]
- pycontrails.core.flight.SHORT_HAUL_DURATION = 3600.0¶
Short haul duration cutoff, [\(s\)]
- pycontrails.core.flight.filter_altitude(time, altitude_ft, kernel_size=17, cruise_threshold=120, air_temperature=None)¶
Filter noisy altitude on a single flight.
Currently runs altitude through a median filter using
scipy.signal.medfilt()
withkernel_size
, then a Savitzky-Golay filter to filter noise. The median filter is only applied during cruise segments that are longer thancruise_threshold
.- Parameters:
time (
npt.NDArray[np.datetime64]
) – Waypoint time innp.datetime64
format.altitude_ft (
npt.NDArray[np.float64]
) – Altitude signal in feetkernel_size (
int
, optional) – Passed directly toscipy.signal.medfilt()
, by default 11. Passed also toscipy.signal.medfilt()
cruise_theshold (
int
, optional) – Minimal length of time, in seconds, for a flight to be in cruise to apply median filterair_temperature (
None | npt.NDArray[np.float64]
) – Air temperature of each flight waypoint, [\(K\)]
- Returns:
npt.NDArray[np.float64]
– Filtered altitude
Notes
Algorithm is derived from
traffic.core.Flight.filter()
.The traffic filter algorithm also computes thresholds on sliding windows and replaces unacceptable values with NaNs.
Errors may raised if the
kernel_size
is too large.
- pycontrails.core.flight.segment_duration(time, dtype=<class 'numpy.float32'>)¶
Calculate the time difference between waypoints.
np.nan
appended so the length of the output is the same as number of waypoints.- Parameters:
time (
npt.NDArray[np.datetime64]
) – Waypoint time innp.datetime64
format.dtype (
np.dtype
) – Numpy dtype for time difference. Defaults tonp.float64
- Returns:
npt.NDArray[np.float64]
– Time difference between waypoints, [\(s\)]. This returns an array with dtype specified by``dtype``.
- pycontrails.core.flight.segment_phase(rocd, altitude_ft, *, threshold_rocd=250.0, min_cruise_altitude_ft=20000.0)¶
Identify the phase of flight (climb, cruise, descent) for each segment.
- Parameters:
rocd (
pt.NDArray[np.float64]
) – Rate of climb and descent across segment, [\(ft min^{-1}\)]. See output fromsegment_rocd()
.altitude_ft (
npt.NDArray[np.float64]
) – Altitude, [\(ft\)]threshold_rocd (
float
, optional) – ROCD threshold to identify climb and descent, [\(ft min^{-1}\)]. Defaults to 250 ft/min.min_cruise_altitude_ft (
float
, optional) – Minimum threshold altitude for cruise, [\(ft\)] This is specific for each aircraft type, and can be approximated as 50% of the altitude ceiling. Defaults toMIN_CRUISE_ALTITUDE
.
- Returns:
npt.NDArray[np.uint8]
– Array of values enumerating the flight phase. Seeflight.FlightPhase
for enumeration.
Notes
Flight data derived from ADS-B and radar sources could contain noise leading to small changes in altitude and ROCD. Hence, an arbitrary
threshold_rocd
is specified to identify the different phases of flight.The flight phase “level-flight” is when an aircraft is holding at lower altitudes. The cruise phase of flight only occurs above a certain threshold altitude.
See also
- pycontrails.core.flight.segment_rocd(segment_duration, altitude_ft, air_temperature=None)¶
Calculate the rate of climb and descent (ROCD).
- Parameters:
segment_duration (
npt.NDArray[np.float64]
) – Time difference between waypoints, [\(s\)]. Expected to have numeric dtype, not “timedelta64”. See output fromsegment_duration()
.altitude_ft (
npt.NDArray[np.float64]
) – Altitude of each waypoint, [\(ft\)]air_temperature (
None | npt.NDArray[np.float64]
) – Air temperature of each flight waypoint, [\(K\)]
- Returns:
npt.NDArray[np.float64]
– Rate of climb and descent over segment, [\(ft min^{-1}\)]
Notes
The hydrostatic equation will be used to estimate the ROCD if air_temperature is provided. This will improve the accuracy of the estimated ROCD with a temperature correction. The estimated ROCD with the temperature correction are expected to differ by up to +-5% compared to those without the correction. These differences are important when the ROCD estimates are used as inputs to aircraft performance models.
See also