PageType.get_AllRegions to list all kinds of regions

ocrd_models/ocrd_models/ocrd_page_generateds.py

@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 #
-# Generated Wed May 13 16:09:07 2020 by generateDS.py version 2.35.20.
-# Python 3.7.6 (default, Jan  8 2020, 19:59:22)  [GCC 7.3.0]
+# Generated Thu May 14 15:35:20 2020 by generateDS.py version 2.35.20.
+# Python 3.6.6 (default, Jul 24 2018, 16:39:20)  [GCC 4.9.2]
 #
 # Command line options:
 #   ('-f', '')
@@ -16,7 +16,7 @@
 #   repo/assets/data/schema/data/2019.xsd
 #
 # Command line:
-#   /home/kba/miniconda3/bin/generateDS -f --root-element="PcGts" -o "ocrd_models/ocrd_models/ocrd_page_generateds.py" --disable-generatedssuper-lookup --user-methods="ocrd_models/ocrd_page_user_methods.py" repo/assets/data/schema/data/2019.xsd
+#   /data/monorepo/venv3.6/bin/generateDS -f --root-element="PcGts" -o "ocrd_models/ocrd_models/ocrd_page_generateds.py" --disable-generatedssuper-lookup --user-methods="ocrd_models/ocrd_page_user_methods.py" repo/assets/data/schema/data/2019.xsd
 #
 # Current working directory (os.getcwd()):
 #   core
@@ -2850,7 +2850,40 @@ def buildChildren(self, child_, node, nodeName_, fromsubclass_=False, gds_collec
             obj_.original_tagname_ = 'CustomRegion'
     def __hash__(self):
         return hash(self.id)
-# end class PageType
+
+    def get_AllRegions(self, regions=None, reading_order=False):
+        """"
+        Get all the *Region element or only those provided by ``regions``.
+        Returned in random order unless ``reading_order`` is set (NOT CURRENTLY IMPLEMENTED)
+        """
+        if reading_order:
+            reading_order = self.get_ReadingOrder()
+        if not regions:
+            regions = ['Advert', 'Chart', 'Chem', 'Custom', 'Graphic', 'Image', 'LineDrawing', 'Map', 'Maths', 'Music', 'Noise', 'Separator', 'Table', 'Text', 'Unknown']
+        ret = []
+        for region in regions:
+            ret += getattr(self, 'get_{}Region'.format(region))()
+        if reading_order:
+            reading_order = reading_order.get_OrderedGroup() or reading_order.get_UnorderedGroup()
+        if reading_order:
+            def get_recursive_reading_order(rogroup):
+                if isinstance(rogroup, (OrderedGroupType, OrderedGroupIndexedType)):
+                    elements = rogroup.get_AllIndexed()
+                if isinstance(rogroup, (UnorderedGroupType, UnorderedGroupIndexedType)):
+                    elements = (rogroup.get_RegionRef() + rogroup.get_OrderedGroup() + rogroup.get_UnorderedGroup())
+                regionrefs = list()
+                for elem in elements:
+                    regionrefs.append(elem.get_regionRef())
+                    if not isinstance(elem, (RegionRefType, RegionRefIndexedType)):
+                        regionrefs.extend(get_recursive_reading_order(elem))
+                return regionrefs
+            reading_order = get_recursive_reading_order(reading_order)
+        if reading_order:
+            ret = dict([(region.id, region) for region in ret])
+            return [ret[region_id] for region_id in reading_order if region_id in ret]
+        else:
+            return ret
+    # end class PageType
 
 
 class CoordsType(GeneratedsSuper):

ocrd_models/ocrd_page_user_methods.py

@@ -83,6 +83,45 @@ def show(self):
 #
 # Replace the following method specifications with your own.
 
+#
+# List all *Regions on the PAGE
+#
+get_AllRegions = MethodSpec(name='get_AllRegions',
+    source=r'''
+    def get_AllRegions(self, regions=None, reading_order=False):
+        """"
+        Get all the *Region element or only those provided by ``regions``.
+        Returned in random order unless ``reading_order`` is set (NOT CURRENTLY IMPLEMENTED)
+        """
+        if reading_order:
+            reading_order = self.get_ReadingOrder()
+        if not regions:
+            regions = ['Advert', 'Chart', 'Chem', 'Custom', 'Graphic', 'Image', 'LineDrawing', 'Map', 'Maths', 'Music', 'Noise', 'Separator', 'Table', 'Text', 'Unknown']
+        ret = []
+        for region in regions:
+            ret += getattr(self, 'get_{}Region'.format(region))()
+        if reading_order:
+            reading_order = reading_order.get_OrderedGroup() or reading_order.get_UnorderedGroup()
+        if reading_order:
+            def get_recursive_reading_order(rogroup):
+                if isinstance(rogroup, (OrderedGroupType, OrderedGroupIndexedType)):
+                    elements = rogroup.get_AllIndexed()
+                if isinstance(rogroup, (UnorderedGroupType, UnorderedGroupIndexedType)):
+                    elements = (rogroup.get_RegionRef() + rogroup.get_OrderedGroup() + rogroup.get_UnorderedGroup())
+                regionrefs = list()
+                for elem in elements:
+                    regionrefs.append(elem.get_regionRef())
+                    if not isinstance(elem, (RegionRefType, RegionRefIndexedType)):
+                        regionrefs.extend(get_recursive_reading_order(elem))
+                return regionrefs
+            reading_order = get_recursive_reading_order(reading_order)
+        if reading_order:
+            ret = dict([(region.id, region) for region in ret])
+            ret = [ret[region_id] for region_id in reading_order if region_id in ret]
+        ret = [r in ret if r.__class__.__name__.replace('RegionType', '') in regions
+        return ret
+    ''', class_names=r'^(PageType)$')
+
 #
 # List all *Indexed children sorted by @index
 #
@@ -167,6 +206,7 @@ def __hash__(self):
     exportChildren,
     get_AllIndexed,
     add_AllIndexed,
+    get_AllRegions,
     clear_AllIndexed,
     )
 

tests/model/test_ocrd_page.py

@@ -184,5 +184,18 @@ def test_empty_groups_to_regionrefindexed(self):
             children = og.get_AllIndexed()
             self.assertTrue(isinstance(children[1], RegionRefIndexedType))
 
+    def test_all_regions_without_reading_order(self):
+        """
+        https://github.com/OCR-D/core/pull/479
+        https://github.com/OCR-D/core/issues/240#issuecomment-493135797
+        """
+        with open('tests/model/TEMP1_Gutachten2-2.xml', 'r') as f:
+            pcgts = parseString(f.read().encode('utf8'), silence=True)
+            pg = pcgts.get_Page()
+            self.assertEqual(len(pg.get_AllRegions()), 45)
+            self.assertEqual(len(pg.get_AllRegions(['Separator'])), 25)
+            self.assertEqual(len(pg.get_AllRegions(['Table'])), 3)
+            self.assertEqual(len(pg.get_AllRegions(['Text'])), 17)
+
 if __name__ == '__main__':
     main()