pygplates.ReconstructedFeatureGeometry

class pygplates.ReconstructedFeatureGeometry

Bases: ReconstructionGeometry

The geometry of a feature reconstructed to a geological time.

ReconstructModel, ReconstructSnapshot or reconstruct() can be used to generate ReconstructedFeatureGeometry instances.

Note

A single feature can have multiple geometry properties, and hence multiple reconstructed feature geometries, associated with it.
Therefore each ReconstructedFeatureGeometry references a different property of the feature via get_property().
__init__()

Raises an exception This class cannot be instantiated from Python

Methods

__init__

Raises an exception This class cannot be instantiated from Python

get_feature()

Returns the feature associated with this ReconstructedFeatureGeometry.

get_present_day_geometry()

Returns the present day geometry.

get_property()

Returns the feature property containing the present day (unreconstructed) geometry associated with this ReconstructedFeatureGeometry.

get_reconstructed_geometry()

Returns the reconstructed geometry.

get_reconstructed_geometry_point_velocities(...)

Returns the velocities of the reconstructed geometry points.

get_reconstructed_geometry_points()

Returns the points of the reconstructed geometry.

get_reconstruction_time()

Returns the reconstruction time that this instance was created at.

get_feature()

Returns the feature associated with this ReconstructedFeatureGeometry.

Return type:

Feature

Note

Multiple reconstructed feature geometries can be associated with the same feature if that feature has multiple geometry properties.

get_present_day_geometry()

Returns the present day geometry.

Return type:

GeometryOnSphere

get_property()

Returns the feature property containing the present day (unreconstructed) geometry associated with this ReconstructedFeatureGeometry.

Return type:

Property

This is the Property that the present day geometry and the reconstructed geometry are obtained from.

get_reconstructed_geometry()

Returns the reconstructed geometry.

Return type:

GeometryOnSphere

get_reconstructed_geometry_point_velocities([velocity_delta_time=1.0][, velocity_delta_time_type=pygplates.VelocityDeltaTimeType.t_plus_delta_t_to_t][, velocity_units=pygplates.VelocityUnits.kms_per_my][, earth_radius_in_kms=pygplates.Earth.mean_radius_in_kms])

Returns the velocities of the reconstructed geometry points.

Parameters:
  • velocity_delta_time (float) – The time delta used to calculate velocities (defaults to 1 Myr).

  • velocity_delta_time_type (VelocityDeltaTimeType.t_plus_delta_t_to_t, VelocityDeltaTimeType.t_to_t_minus_delta_t or VelocityDeltaTimeType.t_plus_minus_half_delta_t) – How the two velocity times are calculated relative to the reconstruction time. This includes [t+dt, t], [t, t-dt] and [t+dt/2, t-dt/2]. Defaults to [t+dt, t].

  • velocity_units (VelocityUnits.kms_per_my or VelocityUnits.cms_per_yr) – whether to return velocities as kilometres per million years or centimetres per year (defaults to kilometres per million years)

  • earth_radius_in_kms (float) – the radius of the Earth in kilometres (defaults to pygplates.Earth.mean_radius_in_kms)

Return type:

list of Vector3D

To associate each velocity with its point (in a reconstructed feature geometry):

points = reconstructed_feature_geometry.get_reconstructed_geometry_points()
velocities = reconstructed_feature_geometry.get_reconstructed_geometry_point_velocities()

points_and_velocities = zip(points, point_velocities)

for point, velocity in points_and_velocities:
  ...

Note

The following:

velocities = reconstructed_feature_geometry.get_reconstructed_geometry_point_velocities(
    velocity_delta_time=1.0,
    velocity_delta_time_type=pygplates.VelocityDeltaTimeType.t_plus_delta_t_to_t)

..is equivalent to:

velocity_stage_rotation = rotation_model.get_rotation(
    reconstructed_feature_geometry.get_reconstruction_time(),
    reconstructed_feature_geometry.get_feature().get_reconstruction_plate_id(),
    reconstructed_feature_geometry.get_reconstruction_time() + 1.0)
velocities = pygplates.calculate_velocities(
    reconstructed_feature_geometry.get_reconstructed_geometry_points(),
    velocity_stage_rotation,
    1.0)

Added in version 0.50.

get_reconstructed_geometry_points()

Returns the points of the reconstructed geometry.

Return type:

list of PointOnSphere

This method is essentially equivalent to:

def get_reconstructed_geometry_points(reconstructed_feature_geometry):
    return reconstructed_feature_geometry.get_reconstructed_geometry().get_points()

Added in version 0.50.