Enumerations

This module contains enumeration types used throughout the TimeAtlas data model.

Layer Type

class timeatlas.TAEnums.LayerType

Bases: Enum

Enumeration for layer types in the Time Atlas data model.

A layer is a synthetic derivation from a map, either from vectorization of specific content or from the actual digital facsimile of the map. It represents objects that users can manipulate to display as a 2D planar field in the interface.

RASTER

Layer formed from an image stored through tiles in the geoserver

VECTOR

Layer formed of Geometry entities that point to it via part_of_layer field

RASTER = 'raster'

VECTOR = 'vector'

Metadata Tag

class timeatlas.TAEnums.MetadataTag

Bases: Enum

Enumeration for broad categorization of metadata fields.

Tags indicate to the information system a broad category for metadata fields, which is useful for triggering specific facet searches in the interface.

PEOPLE

Metadata related to persons or human entities

PLACE

Metadata related to locations or geographical places

LAND_USE

Metadata related to land usage or professions/activities

PEOPLE = 'PEOPLE'

PLACE = 'PLACE'

LAND_USE = 'LAND_USE'

Metadata Type

class timeatlas.TAEnums.MetadataType

Bases: Enum

Enumeration for metadata field data types.

Defines the possible data types for metadata fields in Historical Records, Datasets, and Maps. These types are used for proper parsing, validation, and display of metadata values.

STRING

String of unicode characters, stores text of arbitrary length

INTEGER

Whole number, positive or negative

FLOAT

Decimal numbers

LIST

A list of values of a set type (composite type, e.g., LIST[FLOAT])

URL

A URL string

STRING = 'STRING'

INTEGER = 'INTEGER'

FLOAT = 'FLOAT'

LIST = 'LIST'

URL = 'URL'

Paradata Values

class timeatlas.TAEnums.ParadataValues

Bases: Enum

Enumeration for paradata values indicating data acquisition methods.

Paradata informs users how data was acquired from historical record sources. This metadata about the data production process is important for assessing reliability and understanding the data creation workflow.

MANUAL

Data acquired through manual transcription or entry (m)

AUTOMATIC

Data acquired through purely automatic process without human involvement (a)

SEMIAUTOMATIC

Data acquired through automatic process with manual correction/validation (sa)

AI

Data acquired through artificial intelligence/machine learning (ai)

MANUAL = 'm'

AUTOMATIC = 'a'

SEMIAUTOMATIC = 'sa'

AI = 'ai'

RDE Type

class timeatlas.TAEnums.RDEType

Bases: Enum

Enumeration for Research Data Entity (RDE) types in the Time Atlas data model.

The Time Atlas data model consists of eight main classes of RDE that are manipulated through both the frontend and backend of the time machine information system.

HR

Historical Record - source from which information comes, an “atom” of knowledge

OBS

Observation - space-time representation of information from a historical source

POI

Point of Interest - aggregate of observations at a specific coordinate

GEOM

Geometry - mathematical representation of a physical location as GPS coordinates

DATASET

Dataset - homogeneous collection of information ingested in the system

MAP

Map - group of geographical layers from a single historical map

LAYER

Layer - synthetic derivation from a map (raster or vector)

LAYER_CONFIGURATION

Configuration describing how a layer is served/accessed

AREA

Area - boundary of a geographical entity (continent, country, city, zone)

HR = 'historical_record'

OBS = 'observation'

POI = 'point_of_interest'

GEOM = 'geometry'

DATASET = 'dataset'

MAP = 'map'

LAYER = 'layer'

LAYER_CONFIGURATION = 'layer_configuration'

AREA = 'area'

Type Mappings

The module also provides mapping dictionaries for converting between string representations and enum values:

timeatlas.TAEnums.LAYER_TYPE_TO_ENUM

Mapping dictionary from string layer type names to LayerType enum values.

Used for parsing layer type strings from JSON/dict representations into enum values.

timeatlas.TAEnums.METADATA_TAG_TO_ENUM

Mapping dictionary from string metadata tag names to MetadataTag enum values.

Used for parsing metadata tag strings from JSON/dict representations into enum values.

timeatlas.TAEnums.METADATA_TYPE_TO_ENUM

Mapping dictionary from string metadata type names to MetadataType enum values.

Used for parsing metadata type strings from JSON/dict representations into enum values.

timeatlas.TAEnums.PARADATA_VALUE_TO_ENUM

Mapping dictionary from string paradata values to ParadataValues enum values.

Supports both short codes (m, a, sa, ai) and full names (MANUAL, AUTOMATIC, etc.) for parsing paradata strings from JSON/dict representations into enum values.

timeatlas.TAEnums.CLASS_NAME_TO_RDE

Mapping dictionary from class name strings to RDEType enum values.

Supports multiple naming conventions for backward compatibility: - Short codes (hr, obs, poi) - Snake case (historical_record, point_of_interest) - Single words (historicalrecord, pointofinterest, layerconfiguration)

Used for parsing RDE type strings from JSON/dict representations into enum values.