OCR-D/core

Contents:

• ocrd
  • ocrd package
    • Subpackages
      • ocrd.cli package
        • ocrd
        • Submodules
      • ocrd.decorators package
        • ocrd_cli_wrap_processor()
        • check_and_run_network_agent()
        • Submodules
      • ocrd.processor package
        • Subpackages
        • Submodules
    • Submodules
      • ocrd.constants module
      • ocrd.mets_server module
        • OcrdFileModel
        • OcrdAgentModel
        • OcrdFileListModel
        • OcrdFileGroupListModel
        • OcrdPageListModel
        • OcrdAgentListModel
        • ClientSideOcrdMets
        • MpxReq
        • OcrdMetsServer
      • ocrd.resolver module
        • Resolver
      • ocrd.resource_manager module
        • OcrdResourceManager
      • ocrd.task_sequence module
        • ProcessorTask
        • validate_tasks()
        • run_tasks()
      • ocrd.workspace module
        • Workspace
      • ocrd.workspace_backup module
        • WorkspaceBackup
        • WorkspaceBackupManager
      • ocrd.workspace_bagger module
        • WorkspaceBagger
• ocrd_utils
  • ocrd_utils package
    • Submodules
      • ocrd_utils.config module
        • OcrdEnvVariable
        • OcrdEnvConfig
      • ocrd_utils.constants module
      • ocrd_utils.deprecate module
        • deprecation_warning()
        • deprecated_alias()
        • rename_kwargs()
      • ocrd_utils.image module
        • adjust_canvas_to_rotation()
        • adjust_canvas_to_transposition()
        • bbox_from_points()
        • bbox_from_polygon()
        • bbox_from_xywh()
        • coordinates_for_segment()
        • coordinates_of_segment()
        • image_from_polygon()
        • points_from_bbox()
        • points_from_polygon()
        • points_from_x0y0x1y1()
        • points_from_xywh()
        • points_from_y0x0y1x1()
        • polygon_from_bbox()
        • polygon_from_points()
        • polygon_from_x0y0x1y1()
        • polygon_from_xywh()
        • polygon_mask()
        • rotate_coordinates()
        • shift_coordinates()
        • scale_coordinates()
        • transform_coordinates()
        • transpose_coordinates()
        • xywh_from_bbox()
        • xywh_from_points()
        • xywh_from_polygon()
      • ocrd_utils.introspect module
        • freeze_args()
        • membername()
        • set_json_key_value_overrides()
        • resource_filename()
        • resource_string()
        • dist_version()
      • ocrd_utils.logging module
        • disableLogging()
        • getLevelName()
        • getLogger()
        • initLogging()
        • setOverrideLogLevel()
      • ocrd_utils.os module
        • abspath()
        • directory_size()
        • is_file_in_directory()
        • get_ocrd_tool_json()
        • get_moduledir()
        • get_processor_resource_types()
        • guess_media_type()
        • pushd_popd()
        • unzip_file_to_dir()
        • atomic_write()
        • redirect_stderr_and_stdout_to_file()
      • ocrd_utils.str module
        • assert_file_grp_cardinality()
        • concat_padded()
        • get_local_filename()
        • is_local_filename()
        • partition_list()
        • is_string()
        • make_file_id()
        • make_xml_id()
        • nth_url_segment()
        • parse_json_file_with_comments()
        • parse_json_string_or_file()
        • parse_json_string_with_comments()
        • remove_non_path_from_url()
        • safe_filename()
• ocrd_modelfactory
  • ocrd_modelfactory package
    • exif_from_filename()
    • page_from_file()
    • page_from_image()
• ocrd_models
  • ocrd_models package
    • Submodules
      • ocrd_models.constants module
        • METS_PAGE_DIV_ATTRIBUTE
      • ocrd_models.ocrd_agent module
        • OcrdAgent
        • ClientSideOcrdAgent
      • ocrd_models.ocrd_exif module
        • OcrdExif
      • ocrd_models.ocrd_file module
        • OcrdFile
        • ClientSideOcrdFile
      • ocrd_models.ocrd_mets module
        • OcrdMets
      • ocrd_models.ocrd_page module
        • parse()
        • parseEtree()
        • parseString()
        • OcrdPage
        • AdvertRegionType
        • AlternativeImageType
        • BaselineType
        • BorderType
        • ChartRegionType
        • ChemRegionType
        • CoordsType
        • CustomRegionType
        • GlyphType
        • GraphemeBaseType
        • GraphemeGroupType
        • GraphemeType
        • GraphemesType
        • GraphicRegionType
        • GridPointsType
        • GridType
        • ImageRegionType
        • LabelType
        • LabelsType
        • LayerType
        • LayersType
        • LineDrawingRegionType
        • MapRegionType
        • MathsRegionType
        • MetadataItemType
        • MetadataType
        • MusicRegionType
        • NoiseRegionType
        • NonPrintingCharType
        • OrderedGroupIndexedType
        • OrderedGroupType
        • PageType
        • PcGtsType
        • PrintSpaceType
        • ReadingOrderType
        • RegionRefIndexedType
        • RegionRefType
        • RegionType
        • RelationType
        • RelationsType
        • RolesType
        • SeparatorRegionType
        • TableCellRoleType
        • TableRegionType
        • TextEquivType
        • TextLineType
        • TextRegionType
        • TextStyleType
        • UnknownRegionType
        • UnorderedGroupIndexedType
        • UnorderedGroupType
        • UserAttributeType
        • UserDefinedType
        • WordType
        • to_xml()
      • ocrd_models.ocrd_xml_base module
        • OcrdXmlDocument
      • ocrd_models.report module
        • ValidationReport
      • ocrd_models.utils module
        • xmllint_format()
        • handle_oai_response()
        • is_oai_content()
        • extract_mets_from_oai_content()
      • ocrd_models.xpath_functions module
        • pc_pixelarea()
        • pc_textequiv()
• ocrd_validators
  • ocrd_validators package
    • ParameterValidator
      • ParameterValidator.validate()
    • WorkspaceValidator
      • WorkspaceValidator.check_file_grp()
      • WorkspaceValidator.validate()
    • PageValidator
      • PageValidator.validate()
    • OcrdToolValidator
      • OcrdToolValidator.validate()
    • OcrdResourceListValidator
      • OcrdResourceListValidator.validate()
    • OcrdZipValidator
      • OcrdZipValidator.validate()
    • XsdValidator
      • XsdValidator.instance()
      • XsdValidator.validate()
    • XsdMetsValidator
      • XsdMetsValidator.validate()
    • XsdPageValidator
      • XsdPageValidator.validate()
    • ProcessingServerConfigValidator
      • ProcessingServerConfigValidator.validate()
    • OcrdNetworkMessageValidator
      • OcrdNetworkMessageValidator.validate_message_processing()
      • OcrdNetworkMessageValidator.validate_message_result()
    • Submodules
      • ocrd_validators.constants module
      • ocrd_validators.json_validator module
        • JsonSchemaDeprecationWarning
        • extend_with_default()
        • JsonValidator
      • ocrd_validators.ocrd_network_message_validator module
        • OcrdNetworkMessageValidator
      • ocrd_validators.ocrd_tool_validator module
        • OcrdToolValidator
      • ocrd_validators.ocrd_zip_validator module
        • OcrdZipValidator
      • ocrd_validators.page_validator module
        • ConsistencyError
        • CoordinateConsistencyError
        • CoordinateValidityError
        • compare_without_whitespace()
        • page_get_reading_order()
        • make_poly()
        • make_line()
        • validate_consistency()
        • concatenate()
        • get_text()
        • set_text()
        • PageValidator
      • ocrd_validators.parameter_validator module
        • ParameterValidator
      • ocrd_validators.processing_server_config_validator module
        • ProcessingServerConfigValidator
      • ocrd_validators.resource_list_validator module
        • OcrdResourceListValidator
      • ocrd_validators.workspace_validator module
        • WorkspaceValidator
      • ocrd_validators.xsd_mets_validator module
        • XsdMetsValidator
      • ocrd_validators.xsd_page_validator module
        • XsdPageValidator
      • ocrd_validators.xsd_validator module
        • XsdValidator
• ocrd_network
  • ocrd_network package
    • Subpackages
      • ocrd_network.cli package
        • Submodules
      • ocrd_network.models package
        • DBProcessorJob
        • DBWorkflowJob
        • DBWorkspace
        • DBWorkflowScript
        • PYJobInput
        • PYJobOutput
        • PYOcrdTool
        • PYResultMessage
        • PYWorkflowJobOutput
        • Submodules
      • ocrd_network.rabbitmq_utils package
        • check_if_queue_exists()
        • connect_rabbitmq_consumer()
        • connect_rabbitmq_publisher()
        • create_message_queues()
        • verify_and_parse_mq_uri()
        • verify_rabbitmq_available()
        • RMQConsumer
        • RMQConnector
        • RMQPublisher
        • OcrdProcessingMessage
        • OcrdResultMessage
        • Submodules
      • ocrd_network.runtime_data package
        • Deployer
        • DataHost
        • DataMongoDB
        • DataNetworkAgent
        • DataRabbitMQ
        • DataProcessingWorker
        • DataProcessorServer
        • Submodules
    • Submodules
      • ocrd_network.client module
        • Client
      • ocrd_network.client_utils module
        • poll_job_status_till_timeout_fail_or_success()
        • poll_wf_status_till_timeout_fail_or_success()
        • get_ps_deployed_processors()
        • get_ps_deployed_processor_ocrd_tool()
        • get_ps_processing_job_log()
        • get_ps_processing_job_status()
        • get_ps_workflow_job_status()
        • post_ps_processing_request()
        • post_ps_workflow_request()
        • verify_server_protocol()
      • ocrd_network.constants module
        • AgentType
        • DeployType
        • JobState
        • NetworkLoggingDirs
        • ServerApiTags
      • ocrd_network.database module
        • initiate_database()
        • sync_initiate_database()
        • db_create_workspace()
        • sync_db_create_workspace()
        • db_get_workspace()
        • sync_db_get_workspace()
        • db_update_workspace()
        • sync_db_update_workspace()
        • db_create_processing_job()
        • sync_db_create_processing_job()
        • db_get_processing_job()
        • sync_db_get_processing_job()
        • db_update_processing_job()
        • sync_db_update_processing_job()
        • db_create_workflow_job()
        • sync_db_create_workflow_job()
        • db_get_workflow_job()
        • sync_db_get_workflow_job()
        • db_get_processing_jobs()
        • sync_db_get_processing_jobs()
        • db_create_workflow_script()
        • sync_db_create_workflow_script()
        • db_get_workflow_script()
        • sync_db_get_workflow_script()
        • db_find_first_workflow_script_by_content()
        • sync_db_find_first_workflow_script_by_content()
        • verify_database_uri()
        • verify_mongodb_available()
      • ocrd_network.logging_utils module
        • configure_file_handler_with_formatter()
        • get_root_logging_dir()
        • get_cache_locked_pages_logging_file_path()
        • get_cache_processing_requests_logging_file_path()
        • get_mets_server_logging_file_path()
        • get_processing_job_logging_file_path()
        • get_processing_server_logging_file_path()
        • get_processing_worker_logging_file_path()
        • get_processor_server_logging_file_path()
      • ocrd_network.param_validators module
        • ServerAddressParamType
        • QueueServerParamType
        • DatabaseParamType
      • ocrd_network.process_helpers module
        • invoke_processor()
      • ocrd_network.processing_server module
        • ProcessingServer
      • ocrd_network.processing_worker module
        • ProcessingWorker
      • ocrd_network.processor_server module
        • ProcessorServer
      • ocrd_network.server_cache module
        • CacheLockedPages
        • CacheProcessingRequests
      • ocrd_network.server_utils module
        • create_processing_message()
        • create_workspace_if_not_exists()
        • get_from_database_workflow_job()
        • get_from_database_workspace()
        • get_page_ids_list()
        • request_processor_server_tool_json()
        • forward_job_to_processor_server()
        • get_workflow_content()
        • validate_and_return_mets_path()
        • parse_workflow_tasks()
        • raise_http_exception()
        • validate_job_input()
        • validate_workflow()
        • validate_first_task_input_file_groups_existence()
        • kill_mets_server_zombies()
      • ocrd_network.tcp_to_uds_mets_proxy module
        • MetsServerProxy
      • ocrd_network.utils module
        • call_sync()
        • calculate_execution_time()
        • calculate_processing_request_timeout()
        • convert_url_to_uds_format()
        • expand_page_ids()
        • generate_created_time()
        • generate_id()
        • generate_workflow_content()
        • generate_workflow_content_hash()
        • is_url_responsive()
        • load_ocrd_all_tool_json()
        • post_to_callback_url()
        • get_ocrd_workspace_instance()
        • get_ocrd_workspace_physical_pages()
        • is_mets_server_running()
        • stop_mets_server()
        • get_uds_path()

Indices and tables

• Index

• Module Index

• Search Page