pygplates.GpmlPolarityChronId

class pygplates.GpmlPolarityChronId

Bases: pygplates.PropertyValue

A property value that identifies an Isochron or MagneticAnomalyIdentification.

__init__([era][, major_region][, minor_region][, verify_information_model=VerifyInformationModel.yes])

Create a polarity chron id property value.

Parameters:
  • era (string) – the era of the chron (‘Cenozoic’ or ‘Mesozoic’)
  • major_region (int) – the number indicating the major region the chron is in - Cenozoic isochrons have been classified into broad regions identified by the numbers 1 to 34, Mesozoic isochrons use the numbers 1 to 29
  • minor_region (string) – the sequence of letters indicating the sub-region the chron is located in - the letters a-z are used for the initial sub-region, and if further polarity reversals have been discovered within that chron, a second letter is appended, and so on
  • verify_information_model (VerifyInformationModel.yes or VerifyInformationModel.no) – whether to check the information model for valid era
Raises:

InformationModelError if verify_information_model is VerifyInformationModel.yes and era is not a recognised era value

 
# Create the identifier 'C34ad' for Cenozoic isochron, major region 34, sub region a, sub region d:
polarity_chron_id_property = pygplates.GpmlPolarityChronId('Cenozoic', 34, 'ad')

Methods

__init__([era], [major_region], …) Create a polarity chron id property value.
accept_visitor(visitor) Accept a property value visitor so that it can visit this property value.
clone() Create a duplicate of this property value (derived) instance, including a recursive copy of any nested property values that this instance might contain.
get_era() Returns the era.
get_geometry() Extracts the geometry if this property value contains a geometry.
get_major_region() Returns the major region.
get_minor_region() Returns the minor region.
get_value([time=0]) Extracts the value, of this possibly time-dependent property value, at the reconstruction time.
set_era(era, …) Sets the era.
set_major_region(major_region) Sets the major region.
set_minor_region(minor_region) Sets the minor region.
get_era()

Returns the era.

Returns:the era, or None if the era was not initialised
Return type:string or None
get_major_region()

Returns the major region.

Returns:the major region, or None if the major region was not initialised
Return type:int or None
get_minor_region()

Returns the minor region.

Returns:the minor region, or None if the minor region was not initialised
Return type:string or None
set_era(era[, verify_information_model=VerifyInformationModel.yes])

Sets the era.

Parameters:
  • era (string) – the era of the chron (‘Cenozoic’ or ‘Mesozoic’)
  • verify_information_model (VerifyInformationModel.yes or VerifyInformationModel.no) – whether to check the information model for valid era
Raises:

InformationModelError if verify_information_model is VerifyInformationModel.yes and era is not a recognised era string value
set_major_region(major_region)

Sets the major region.

Parameters:major_region (int) – the number indicating the major region the chron is in - Cenozoic isochrons have been classified into broad regions identified by the numbers 1 to 34, Mesozoic isochrons use the numbers 1 to 29
set_minor_region(minor_region)

Sets the minor region.

Parameters:minor_region (string) – the sequence of letters indicating the sub-region the chron is located in - the letters a-z are used for the initial sub-region, and if further polarity reversals have been discovered within that chron, a second letter is appended, and so on