API

This the API documentation for the Land Sealing Dataset creation.

• Data Pipeline
  • Download NRW building plan PDFs
    • parse_geojson()
    • run_pdf_downloader()
    • merge_rp_bp()
    • export_merged_bp_rp()
  • Extract Text from PDFs
    • pdf_parser_from_folder()
    • pdf_parser_from_path()
  • Parsing the regional plans
    • RPlanContentExtractor
      • RPlanContentExtractor.extract_chapter_names()
      • RPlanContentExtractor.find_chapter_name_for_indices()
      • RPlanContentExtractor.parse_into_sections()
      • RPlanContentExtractor.parse_rplan_from_textfile()
      • RPlanContentExtractor.preprocess_rplan_content()
      • RPlanContentExtractor.read_text()
    • parse_rplan_directory()
    • parse_result_df()
• Feature Extraction
  • Document Categorization
    • run_bp_keyword_detector()
  • Textual Feature Extraction
    • enrich_extracts_with_metadata()
    • Fuzzy Keyword Search
      • find_best_matches()
      • search_df_for_best_matches()
      • search_best_matches_dict()
      • search_df_for_best_matches_keyword_dict()
    • Exact Keyword Search
      • search_text_for_keywords()
      • search_df_for_keywords()
    • Agent
      • extract_knowledge_from_df()
    • Regional Plan Keyword Search
      • rplan_exact_keyword_search()
      • rplan_fuzzy_keyword_search()
      • negate_keyword_search()
      • plot_keyword_search_results()