Python API Reference

1. Global Functions

1.1. reconstruct(recon_files, rotation_files, time, anchor_plate_id, output_file)

    recon_files = ["input_1.gpml", "input_2.gpml"]

    rot_files = ["rotation.rot"]

    pygplates.reconstruct(recon_files, rot_files, 20, 0, "output.xy")
    pygplates.reconstruct(recon_files, rot_files, 20, 0, "output.shp")
    pygplates.reconstruct(recon_files, rot_files, 20, 0, "output.gmt")

Reconstruct reconstructable and rotaion files. Support three three output file formats ".xy(gmt)", ".shp(shapefile)" and ".gmt(OGRGMT)".

1.2. register(object)

def register():
        pygplates.Application().register_draw_style(obj)

During GPlates' start-up, all the "register()" functions in Python script files are called. Use this function to register your Python script.

2. Application

2.1. register_draw_style(object)

    pygplates.Application().register_draw_style(obj)

Register a Draw Style plugin with GPlates. The Draw Style plugin should be an instance of a Python class in which a "get_style(self, feature, style)" function has been defined.

2.2. feature_collections()

   pygplates.Application().feature_collections()

Return a list of feature collections, which currently have been loaded into GPlates.

2.3. get_loaded_files()

    pygplates.Application().get_loaded_files()

Return a list of file names, which currently have been opened by GPlates.

2.4. current_time()

     pygplates.Application().current_time()

Return current reconstruction time as float number.

3. Colour

3.1. Colour(red, green, blue, alpha)

Construct a colour with the given red, green and blue components.

The parameters represent the percentage of red, green and blue in the resulting colour. They should be in the range [0.0 - 1.0] inclusive.

Values outside this range will not be clamped, since OpenGL does its own clamping.

black = pygplates.Colour(0.0, 0.0, 0.0, 1.0)
white = pygplates.Colour(1.0, 1.0, 1.0, 1.0)
red   = pygplates.Colour(1.0, 0.0, 0.0, 1.0)
green = pygplates.Colour(0.0, 0.5, 0.0, 1.0)

Static members:

blue
red
white
black
green
grey
silver
purple
yellow
navy

4. DrawStyle

Currently, DrawStyle only contains a public member "colour". However it is essential in colouring geometries.

Users can set colour like this:

style.colour = pygplates.Colour(1.0, 0.0, 0.0, 1.0)

5. Feature

5.1. begin_time()

Return "feature begin time" as float number.

5.2. end_time()

Return "feature end time" as float number.

5.3. feature_id()

Return "feature id" as a string.

5.4. feature_type()

Return "feature type" as a string.

5.5. get_all_property_names()

Return a list of names(strings) of all properties contained in this feature.

5.6. get_properties()

Return all properties in this feature as a list of strings.

5.7. get_properties_by_name(name)

Given a property name, return all properties as a list of strings in this feature which bear this name.

5.8. plate_id()

Return "plate id" as a integer.

5.9. valid_time()

Return "start time" and "end time" together as a tuple. The t[0] is the "start time", t[1] is "end time".