eml.resources.coverage package#
GeographicCoverage Class#
- class eml.resources.coverage.geo_coverage.GeographicCoverage(description: str, west_bounding: float, east_bounding: float, north_bounding: float, south_bounding: float, _id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, altitude_bounding: Tuple[float, float] = None, altitude_units: LengthUnit = None, g_polygon: List[GPolygon] = None)#
Bases:
EMLObjectGeographic coverage information.
- Parameters:
- descriptionstr
Short text description of the geographic areal domain of the data set.
- west_boundingfloat
Western-most limit of a bounding box, expressed in degrees of longitude.
- east_boundingfloat
Eastern-most limit of a bounding box, expressed in degrees of longitude.
- north_boundingfloat
Northern-most limit of a bounding box, expressed in degrees of latitude.
- south_boundingfloat
Southern-most limit of a bounding box, expressed in degrees of latitude.
- _idstr, optional
Unique identifier within the scope.
- scopeScope, default DOCUMENT
The scope of the identifier.
- systemstr, optional
The data management system within which an identifier is in scope and therefore unique.
- referencingbool, optional, default=False
Whether the resource is referencing another or is being defined.
- references_systemstr, optional
System attribute of reference.
- altitude_boundingTuple[float, float], optional
The vertical limits of a data set expressed by altitude.
- altitude_unitsLengthUnit, optional
The unit of altitude.
- g_polygonList[Tuple[List[Tuple[float, float]], List[Tuple[float, float]]]], optional
This construct creates a spatial ring with a hollow center.
- Attributes:
- NAMESPACE_TAG
altitude_units_boundingLengthUnit: The unit of altitude.
descriptionstr: Short text description of the geographic areal domain of the data set.
east_boundingfloat: Eastern-most limit of a bounding box, expressed in degrees of longitude.
g_polygonList[GPolygon]: This construct creates a spatial ring with a hollow center.
idstr: Unique identifier of the resource
max_altitude_boundingfloat: The maximum altitude extent of coverage.
min_altitude_boundingfloat: The minimum altitude extent of coverage.
north_boundingfloat: Northern-most limit of a bounding box, expressed in degrees of latitude.
referencesbool: Whether the resource is referencing another or is being defined
referencingbool: Whether the resource is referencing another or is being defined
scopeScope: The scope of the identifier.
south_boundingfloat: Southern-most limit of a bounding box, expressed in degrees of latitude.
systemstr: The data management system within which an identifier is in scope and therefore unique.
west_boundingfloat: Western-most limit of a bounding box, expressed in degrees of longitude.
Methods
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
generate_references_element()Generate the <references> element.
get_no_referrer(element, nmap)Generate a GeographicCoverage that do not reference another.
get_principal_tag()Returns the principal tag with namespaces if it is present.
get_referrer(element, nmap)Generate an GeographicCoverage referencing another GeographicCoverage.
get_scope(element)Get the scope from the element.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Common parse of an EML object
polygon_to_xml(polygon)Convert a GPolygon object into an XML Element.
ring_to_xml(ring)Convert a GRing object into an XML Element.
Generates a lxml.tree.Element from the object.
to_xml()Generates text of an XML file.
xml_to_polygon(element, nmap)Convert a lxml.tree.Element into a GPolygon object.
xml_to_ring(element, nmap)Convert a lxml.tree.Element into a GRing object.
- PRINCIPAL_TAG = 'geographicCoverage'#
str : The principal tag of the XML document.
- property altitude_units_bounding: LengthUnit#
LengthUnit: The unit of altitude.
- property description: str#
str: Short text description of the geographic areal domain of the data set.
- property east_bounding: float#
float: Eastern-most limit of a bounding box, expressed in degrees of longitude.
- property g_polygon: List[GPolygon]#
List[GPolygon]: This construct creates a spatial ring with a hollow center.
- classmethod get_no_referrer(element: Element, nmap: Dict) GeographicCoverage#
Generate a GeographicCoverage that do not reference another.
- Parameters:
- elementlxml.etree.Element
XML element to parse.
- nmapDict
Namespace.
- Returns:
- GeographicCoverage
Object parsed.
- classmethod get_referrer(element: Element, nmap: Dict) GeographicCoverage#
Generate an GeographicCoverage referencing another GeographicCoverage.
- Parameters:
- elementlxml.etree.Element
XML element to parse with references object.
- nmapDict
Namespace.
- Returns:
- GeographicCoverage
Object parsed that reference another.
- property max_altitude_bounding: float#
float: The maximum altitude extent of coverage.
- property min_altitude_bounding: float#
float: The minimum altitude extent of coverage.
- property north_bounding: float#
float: Northern-most limit of a bounding box, expressed in degrees of latitude.
- static polygon_to_xml(polygon: GPolygon) Element#
Convert a GPolygon object into an XML Element.
- Parameters:
- polygonGPolygon
A valid GPolygon object.
- Returns:
- lxml.tree.Element
XML element with the GPolygon information.
- static ring_to_xml(ring: GRing) Element#
Convert a GRing object into an XML Element.
- Parameters:
- ringGRing
A valid GRing object.
- Returns:
- lxml.tree.Element
XML element with the GPolygon information.
- property south_bounding: float#
float: Southern-most limit of a bounding box, expressed in degrees of latitude.
- to_element() Element#
Generates a lxml.tree.Element from the object.
- Returns:
- lxml.tree.Element
Geographic Coverage in the Element format.
- property west_bounding: float#
float: Western-most limit of a bounding box, expressed in degrees of longitude.
TemporalCoverage Class#
- class eml.resources.coverage.time_coverage.TemporalCoverage(_id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, single_datetime: List[date | datetime | AlternativeTimeScale] = None, range_datetime: Tuple[date | datetime | AlternativeTimeScale, date | datetime | AlternativeTimeScale] = None)#
Bases:
EMLObjectTemporal coverage information.
- Parameters:
- _idstr, optional
Unique identifier within the scope.
- scopeScope, default DOCUMENT
The scope of the identifier.
- systemstr, optional
The data management system within which an identifier is in scope and therefore unique.
- referencingbool, optional, default=False
Whether the resource is referencing another or is being defined.
- references_systemstr, optional
System attribute of reference.
- single_datetimeList[date or datetime or AlternativeTimeScale], optional
Means of encoding a single date and time.
- range_datetime: Tuple[date or datetime or AlternativeTimeScale], optional
Means of encoding a range of dates and times.
- Attributes:
- NAMESPACE_TAG
idstr: Unique identifier of the resource
range_datetimeTuple[date or datetime or AlternativeTimeScale]: Means of encoding a range of dates and times.
referencesbool: Whether the resource is referencing another or is being defined
referencingbool: Whether the resource is referencing another or is being defined
scopeScope: The scope of the identifier.
single_datetimeList[date or datetime or AlternativeTimeScale]: Means of encoding a single date and time.
systemstr: The data management system within which an identifier is in scope and therefore unique.
Methods
AlternativeTimeScale(name, age_estimate[, ...])A name, code, or date describing an event or period in an alternative timescale.
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
datetime_to_xml(datetime)Convert a datetime to an XML element instance.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
generate_references_element()Generate the <references> element.
get_no_referrer(element, nmap)Generate a TemporalCoverage that do not reference another.
get_principal_tag()Returns the principal tag with namespaces if it is present.
get_referrer(element, nmap)Generate a Time Coverage referencing another Time Coverage.
get_scope(element)Get the scope from the element.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Common parse of an EML object
Generate an XML element with the information of the TemporalCoverage object.
to_xml()Generates text of an XML file.
xml_to_datetime(element, nmap)Convert an XML element instance to datetime object in the correspondant format.
- class AlternativeTimeScale(name: str, age_estimate: str, age_uncertainty: str = None, age_explanation: str = None, citation: List = None)#
Bases:
XMLObjectA name, code, or date describing an event or period in an alternative timescale.
- Parameters:
- namestr
Name of a recognized alternative timescale.
- age_estimatestr
Either an absolute date or a relative age name describing an event or period in an alternative timescale.
- age_uncertaintystr, optional
The error estimate for the alternative timescale.
- age_explanationstr, optional
The name and/or description of the method used to calculate the timescale age estimate.
- citationList[EMLCitation], optional
Citation for works providing detailed information about any element of the timescale age.
- Attributes:
- NAMESPACE_TAG
age_estimatestr: Age name describing an event or period in an alternative timescale.
age_explanationstr: The name and/or description of the method used to calculate the timescale age estimate.
age_uncertaintystr: The error estimate for the alternative timescale.
citationList[EMLCitation]: Citation for works providing detailed information about any element of the timescale age.
namestr: Name of a recognized alternative time scale.
Methods
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
get_principal_tag()Returns the principal tag with namespaces if it is present.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Generate an Alternative TimeScale object from an XML element.
Generate an XML element from the information of this instance.
to_xml()Generates text of an XML file.
- PRINCIPAL_TAG = 'alternativeTimeScale'#
str : The principal tag of the XML document.
- property age_estimate: str#
str: Age name describing an event or period in an alternative timescale.
- property age_explanation: str#
str: The name and/or description of the method used to calculate the timescale age estimate.
- property age_uncertainty: str#
str: The error estimate for the alternative timescale.
- property citation: List#
List[EMLCitation]: Citation for works providing detailed information about any element of the timescale age.
- property name: str#
str: Name of a recognized alternative time scale.
- classmethod parse(element: Element, nmap: Dict) AlternativeTimeScale | None#
Generate an Alternative TimeScale object from an XML element.
- Parameters:
- elementlxml.etree.Element
XML element instance to parse.
- nmapDict
Namespace.
- Returns:
- AlternativeTimeScale
Instance with the information of the XML
- to_element() Element#
Generate an XML element from the information of this instance.
- Returns:
- lxml.etree.Element
An XML element
- PRINCIPAL_TAG = 'temporalCoverage'#
str : The principal tag of the XML document.
- static datetime_to_xml(datetime: date | datetime | AlternativeTimeScale) Element#
Convert a datetime to an XML element instance.
- Parameters:
- datetimedatetime, date or AlternativeTimeScale
XML element to parse.
- Returns:
- lxml.etree.Element
XML element instance.
- Raises:
- TypeError
Not a valid datetime.
- classmethod get_no_referrer(element: Element, nmap: Dict) TemporalCoverage#
Generate a TemporalCoverage that do not reference another.
- Parameters:
- elementlxml.etree.Element
XML element to parse.
- nmapDict
Namespace.
- Returns:
- TemporalCoverage
Object parsed.
- classmethod get_referrer(element: Element, nmap: Dict) TemporalCoverage#
Generate a Time Coverage referencing another Time Coverage.
- Parameters:
- elementlxml.etree.Element
XML element to parse with references object.
- nmapDict
Namespace.
- Returns:
- TemporalCoverage
Object parsed that reference another.
- property range_datetime: Tuple[date | datetime | AlternativeTimeScale, date | datetime | AlternativeTimeScale]#
Tuple[date or datetime or AlternativeTimeScale]: Means of encoding a range of dates and times.
- property single_datetime: List[date | datetime | AlternativeTimeScale]#
List[date or datetime or AlternativeTimeScale]: Means of encoding a single date and time.
- to_element() Element#
Generate an XML element with the information of the TemporalCoverage object.
- Returns:
- lxml.etree.Element
AN XML element.
- static xml_to_datetime(element: Element, nmap: Dict) date | datetime | AlternativeTimeScale#
Convert an XML element instance to datetime object in the correspondant format.
- Parameters:
- elementlxml.etree.Element
XML element to parse.
- nmapDict
Namespace.
- Returns:
- datetime, date or AlternativeTimeScale
Datetime in the corresponding format.
TaxonomicCoverage Class#
- class eml.resources.coverage.taxa_coverage.TaxonomicCoverage(_id: str = None, scope: Scope = Scope.DOCUMENT, system: str = None, referencing: bool = False, references_system: str = None, taxonomic_system: TaxonomicSystem = None, general_coverage: str = None, classification: List[TaxonomicClassification] = None)#
Bases:
EMLObjectTaxonomic coverage information.
- Parameters:
- _idstr, optional
Unique identifier within the scope.
- scopeScope, default DOCUMENT
The scope of the identifier.
- systemstr, optional
The data management system within which an identifier is in scope and therefore unique.
- referencingbool, optional, default=False
Whether the resource is referencing another or is being defined.
- references_systemstr, optional
System attribute of reference.
- taxonomic_systemTaxonomicSystem, optional
Documentation of taxonomic sources, procedures, and treatments.
- general_coveragestr, optional
A description of the range of taxa addressed in the data set or collection.
- classificationList[ClassificationSystem], optional
Information about the range of taxa addressed in the data set or collection.
- Attributes:
- NAMESPACE_TAG
classificationTaxonomicClassification: Information about the range of taxa addressed in the data set or collection.
general_coveragestr: A description of the range of taxa addressed in the data set or collection.
idstr: Unique identifier of the resource
referencesbool: Whether the resource is referencing another or is being defined
referencingbool: Whether the resource is referencing another or is being defined
scopeScope: The scope of the identifier.
systemstr: The data management system within which an identifier is in scope and therefore unique.
taxonomic_systemTaxonomicSystem: Documentation of taxonomic sources, procedures, and treatments.
Methods
ClassificationSystem(citation[, modifications])Information about the classification system or authority used.
TaxonID(_id, provider)Element holds an ID and ID-provider for this taxon.
TaxonomicClassification([_id, rank_name, ...])Information about the range of taxa addressed in the data set or collection.
TaxonomicSystem(procedures, ...[, ...])Documentation of taxonomic sources, procedures, and treatments.
Voucher(specimen, repository)Information on the types of specimen, the repository, and the individuals who identified the vouchers.
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
generate_references_element()Generate the <references> element.
get_no_referrer(element, nmap)Generate a Taxonomic Coverage instance that do not reference another.
get_principal_tag()Returns the principal tag with namespaces if it is present.
get_referrer(element, nmap)Generate a Taxonomic Coverage referencing another Taxonomic Coverage.
get_scope(element)Get the scope from the element.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Common parse of an EML object
Generate an XML element instance using object information.
to_xml()Generates text of an XML file.
- class ClassificationSystem(citation: EMLObject, modifications: str = None)#
Bases:
objectInformation about the classification system or authority used.
- Parameters:
- citationEMLCitation
Relevant literature for documenting the used classification system.
- modificationsstr, optional
A description of any modifications or exceptions made to the classification system or authority used.
- Attributes:
citationEMLCitation: Relevant literature for documenting the used classification system.
modificationsstr: A description of any modifications or exceptions made to the classification system or authority used.
- property citation: EMLObject#
EMLCitation: Relevant literature for documenting the used classification system.
- property modifications: str#
str: A description of any modifications or exceptions made to the classification system or authority used.
- PRINCIPAL_TAG = 'taxonomicCoverage'#
str : The principal tag of the XML document.
- class TaxonID(_id: str, provider: str)#
Bases:
objectElement holds an ID and ID-provider for this taxon.
- Parameters:
- _id: str
The identifier for this taxon from an authority.
- provider: str
The taxonomic authority from which the taxonId can be retrieved, defined as the namespace URI.
- Attributes:
- property id: str#
str: The identifier for this taxon from an authority.
- property provider: str#
str: The taxonomic authority from which the taxonId can be retrieved, defined as the namespace URI.
- class TaxonomicClassification(_id: str = None, rank_name: str = None, rank_value: str = None, common_name: List[str] = None, taxon_id: List[Tuple[str, str]] = None, classification: List[TaxonomicClassification] = None)#
Bases:
XMLObjectInformation about the range of taxa addressed in the data set or collection.
- Parameters:
- _idstr, optional
A unique identifier for this additional metadata that can be used to reference it elsewhere.
- rank_namestr, optional
The name of the taxonomic rank for which the Taxon rank value is provided.
- rank_valuestr, optional
The taxonomic rank name being described.
- common_name: List[str], optional
Specification of applicable xml_common names.
- taxon_id: List[Tuple[str, str]], optional
Element holds an ID and ID-provider for this taxon.
- classification: List[TaxonClassification], optional
Taxonomic Classification field is self-referencing to allow for an arbitrary depth of rank, down to species.
- Attributes:
- NAMESPACE_TAG
classificationList[TaxonomicClassification]: Taxonomic Classification field self-referenced.
common_nameList[str]: Specification of applicable xml_common names.
idstr: A unique identifier for this additional metadata that can be used to reference it elsewhere.
rank_namestr: The name of the taxonomic rank for which the Taxon rank value is provided.
rank_valuestr: The taxonomic rank name being described.
taxon_idList[TaxonID]: Element holds an ID and ID-provider for this taxon.
Methods
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
get_principal_tag()Returns the principal tag with namespaces if it is present.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Generate a TaxonomicClassification instance from an XML element.
Generate an XML element instance with the information of this object.
to_xml()Generates text of an XML file.
- PRINCIPAL_TAG = 'taxonomicClassification'#
str : The principal tag of the XML document.
- property classification: List[TaxonomicClassification]#
List[TaxonomicClassification]: Taxonomic Classification field self-referenced.
- property common_name: List[str]#
List[str]: Specification of applicable xml_common names.
- property id: str#
str: A unique identifier for this additional metadata that can be used to reference it elsewhere.
- classmethod parse(element: Element, nmap: Dict) TaxonomicClassification | None#
Generate a TaxonomicClassification instance from an XML element.
- Parameters:
- elementlxml.etree.Element
XML Element to be parsed.
- nmapDict
Namespace
- Returns:
- TaxonomicClassification
An instance with the XML element information.
- property rank_name: str#
str: The name of the taxonomic rank for which the Taxon rank value is provided.
- property rank_value: str#
str: The taxonomic rank name being described.
- property taxon_id: List[TaxonID]#
List[TaxonID]: Element holds an ID and ID-provider for this taxon.
- to_element() Element#
Generate an XML element instance with the information of this object.
- Returns:
- lxml.etree.Element
XML element instance.
- class TaxonomicSystem(procedures: str, classification_system: List, identifier_name: List[ResponsibleParty], identification_reference: List = None, completeness: str = None, vouchers: List[Tuple[str, List[ResponsibleParty]]] = None, modifications: List[str] = None)#
Bases:
XMLObjectDocumentation of taxonomic sources, procedures, and treatments.
- Parameters:
- proceduresstr
Description of the methods used for the taxonomic identification.
- classification_systemList[EMLCitation]
Relevant literature for documenting the used classification system.
- identifier_nameList[ResponsibleParty]
Information about the individual(s) responsible for the identification(s) of the specimens or sightings.
- identification_referenceList[EMLCitation], optional
Information on any non-authoritative materials.
- completenessstr, optional
Taxonomic completeness.
- vouchersList[Tuple[str, List[ResponsibleParty]]], optional
Information on the types of specimen, the repository, and the individuals who identified the vouchers.
- modificationsList[str], optional
A description of any modifications or exceptions made to the classification system or authority used.
- Attributes:
- NAMESPACE_TAG
classification_systemList[ClassificationSystem]: Information about the classification system or authority used.
completenessstr: Taxonomic completeness.
identification_referenceList[EMLCitation]: Information on any non-authoritative materials.
identifier_nameList[ResponsibleParty]: Information about the individual(s) responsible for the identification(s).
proceduresstr: Description of the methods used for the taxonomic identification.
vouchersList[Voucher]: Information on the types of specimen and the repository.
Methods
add_namespace(prefix, uri)Add a namespace to the XML object.
check_principal_tag(tag, nmap)Checks if the tag is the Principal tag of the object.
from_string(text)Generates XML Object from a string of an XML file.
from_xml(file[, encoding])Generates an XML Object from an XML file.
get_principal_tag()Returns the principal tag with namespaces if it is present.
object_to_element(tag[, prefix])Generates an element using tag, adding namespace tag.
parse(element, nmap)Generate a TaxonomicSystem instance from an XML element instance.
Generate an XML instance using this object.
to_xml()Generates text of an XML file.
- PRINCIPAL_TAG = 'taxonomicSystem'#
str : The principal tag of the XML document.
- property classification_system: List[ClassificationSystem]#
List[ClassificationSystem]: Information about the classification system or authority used.
- property completeness: str#
str: Taxonomic completeness.
- property identification_reference: List#
List[EMLCitation]: Information on any non-authoritative materials.
- property identifier_name: List[ResponsibleParty]#
List[ResponsibleParty]: Information about the individual(s) responsible for the identification(s).
- classmethod parse(element: Element, nmap: Dict) TaxonomicSystem | None#
Generate a TaxonomicSystem instance from an XML element instance.
- Parameters:
- elementlxml.etree.Element
XML element to parse.
- nmapDict
Namespace.
- Returns:
- TaxonomicSystem
Instance with the same information as the XML element.
- property procedures: str#
str: Description of the methods used for the taxonomic identification.
- to_element() Element#
Generate an XML instance using this object.
- Returns:
- lxml.etree.Element
XML element instance.
- class Voucher(specimen: str, repository: List[ResponsibleParty])#
Bases:
objectInformation on the types of specimen, the repository, and the individuals who identified the vouchers.
- Parameters:
- specimenstr
A word or phrase describing the type of specimen collected.
- repositoryList[ResponsibleParty]
Information about the curator or contact person and/or agency responsible for the specimens.
- Attributes:
repositoryList[ResponsibleParty]: Information about the responsible for the specimens.
specimenstr: A word or phrase describing the type of specimen collected.
- property repository: List[ResponsibleParty]#
List[ResponsibleParty]: Information about the responsible for the specimens.
- property specimen: str#
str: A word or phrase describing the type of specimen collected.
- property classification: List[TaxonomicClassification]#
TaxonomicClassification: Information about the range of taxa addressed in the data set or collection.
- property general_coverage: str#
str: A description of the range of taxa addressed in the data set or collection.
- classmethod get_no_referrer(element: Element, nmap: Dict) TaxonomicCoverage#
Generate a Taxonomic Coverage instance that do not reference another.
- Parameters:
- elementlxml.etree.Element
XML element to parse.
- nmapDict
Namespace.
- Returns:
- TaxonomicCoverage
Object parsed.
- classmethod get_referrer(element: Element, nmap: Dict) EMLObject#
Generate a Taxonomic Coverage referencing another Taxonomic Coverage.
- Parameters:
- elementlxml.etree.Element
XML element to parse with references object.
- nmapDict
Namespace.
- Returns:
- TaxonomicCoverage
Taxonomic Coverage object parsed that reference another.
- property taxonomic_system: TaxonomicSystem#
TaxonomicSystem: Documentation of taxonomic sources, procedures, and treatments.
- to_element() Element#
Generate an XML element instance using object information.
- Returns:
- lxml.etree.Element
XML element instance.