"""
BRAINGLOBE ATLAS
==============================
Customized map based on Wang et al 2020,
Handle the different naming/category with allenccf registration result
:Generated on:
24/09/2020
:name:
allen_mouse
:citation:
Wang et al 2020, https://doi.org/10.1016/j.cell.2020.04.007
:atlas_link:
http://www.brain-map.org
:species:
Mus musculus
:symmetric:
True
:resolution:
``(10.0, 10.0, 10.0)``
:orientation:
``asr``
:version:
``1.2``
:shape:
``(1320, 800, 1140)``
:trasform_to_bg:
``((1.0, 0.0, 0.0, 0.0), (0.0, 1.0, 0.0, 0.0), (0.0, 0.0, 1.0, 0.0), (0.0, 0.0, 0.0, 1.0))``
:additional_references:
(none)
**BRAIN STRUCTURES TREE**
- Seealso :func:`~neuralib.atlas.plot.plot_structure_tree()`
::
root (997)
├── VS (73)
│ ├── AQ (140)
│ ├── V3 (129)
│ ├── V4 (145)
│ │ └── V4r (153)
│ ├── VL (81)
│ │ ├── SEZ (98)
│ │ └── chpl (108)
│ └── c (164)
├── fiber tracts (1009)
│ ├── cbf (960)
│ │ ├── arb (728)
│ │ ├── cbc (744)
│ │ └── cbp (752)
│ │ ├── icp (1123)
│ │ │ └── sctd (553)
│ │ ├── mcp (78)
│ │ └── scp (326)
│ │ ├── dscp (812)
│ │ ├── sctv (866)
│ │ └── uf (850)
│ ├── cm (967)
│ │ ├── IIIn (832)
│ │ │ ├── mlf (62)
│ │ │ └── pc (158)
│ │ ├── IIn (848)
│ │ │ ├── bsc (916)
│ │ │ ├── csc (336)
│ │ │ ├── och (117)
│ │ │ └── opt (125)
│ │ ├── IVn (911)
│ │ ├── In (840)
│ │ │ ├── aco (900)
│ │ │ ├── lotg (21)
│ │ │ │ ├── lot (665)
│ │ │ │ └── lotd (538)
│ │ │ └── onl (1016)
│ │ ├── VIIIn (933)
│ │ │ ├── cVIIIn (948)
│ │ │ │ ├── bic (482)
│ │ │ │ ├── cic (633)
│ │ │ │ ├── das (506)
│ │ │ │ ├── ll (658)
│ │ │ │ └── tb (841)
│ │ │ └── vVIIIn (413)
│ │ ├── VIIn (798)
│ │ │ └── gVIIn (1116)
│ │ ├── Vn (901)
│ │ │ ├── moV (93)
│ │ │ └── sV (229)
│ │ │ └── sptV (794)
│ │ ├── Xn (917)
│ │ │ └── ts (237)
│ │ ├── drt (792)
│ │ │ └── cett (932)
│ │ │ ├── dc (514)
│ │ │ │ └── cuf (380)
│ │ │ └── ml (697)
│ │ └── von (949)
│ ├── eps (1000)
│ │ ├── epsc (760)
│ │ │ └── nst (102)
│ │ ├── rust (863)
│ │ │ └── vtd (397)
│ │ └── tsp (877)
│ │ ├── dtd (1060)
│ │ ├── tspc (1043)
│ │ └── tspd (1051)
│ ├── lfbs (983)
│ │ ├── cc (776)
│ │ │ ├── ccb (484682516)
│ │ │ ├── ccg (1108)
│ │ │ ├── ccs (986)
│ │ │ ├── ee (964)
│ │ │ ├── fa (956)
│ │ │ │ └── ec (579)
│ │ │ └── fp (971)
│ │ ├── cst (784)
│ │ │ ├── cpd (924)
│ │ │ ├── int (6)
│ │ │ ├── py (190)
│ │ │ └── pyd (198)
│ │ └── lfbst (896)
│ │ ├── ar (484682524)
│ │ ├── em (1092)
│ │ └── or (484682520)
│ ├── mfbs (991)
│ │ ├── mfbc (768)
│ │ │ ├── act (908)
│ │ │ ├── amc (884)
│ │ │ ├── cing (940)
│ │ │ ├── fxs (1099)
│ │ │ │ ├── alv (466)
│ │ │ │ ├── df (530)
│ │ │ │ ├── fi (603)
│ │ │ │ ├── fxpo (737)
│ │ │ │ │ ├── fx (436)
│ │ │ │ │ └── mct (428)
│ │ │ │ └── hc (618)
│ │ │ │ ├── dhc (443)
│ │ │ │ └── vhc (449)
│ │ │ └── st (301)
│ │ │ └── stc (484682528)
│ │ └── mfsbshy (824)
│ │ ├── mfb (54)
│ │ ├── mfbse (1083)
│ │ │ ├── fr (595)
│ │ │ ├── hbc (611)
│ │ │ └── sm (802)
│ │ ├── mfbsma (46)
│ │ │ ├── mp (673)
│ │ │ ├── mtg (681)
│ │ │ ├── mtt (690)
│ │ │ └── pm (753)
│ │ └── sup (349)
│ └── scwm (484682512)
└── grey (8)
├── BS (343)
│ ├── HB (1065)
│ │ ├── MY (354)
│ │ │ ├── MY-mot (370)
│ │ │ │ ├── ACVII (576)
│ │ │ │ ├── AMB (135)
│ │ │ │ │ ├── AMBd (939)
│ │ │ │ │ └── AMBv (143)
│ │ │ │ ├── DMX (839)
│ │ │ │ ├── GRN (1048)
│ │ │ │ ├── ICB (372)
│ │ │ │ ├── IO (83)
│ │ │ │ ├── IRN (136)
│ │ │ │ ├── ISN (106)
│ │ │ │ ├── LIN (203)
│ │ │ │ ├── LRN (235)
│ │ │ │ │ ├── LRNm (955)
│ │ │ │ │ └── LRNp (963)
│ │ │ │ ├── MARN (307)
│ │ │ │ ├── MDRN (395)
│ │ │ │ │ ├── MDRNd (1098)
│ │ │ │ │ └── MDRNv (1107)
│ │ │ │ ├── PARN (852)
│ │ │ │ ├── PAS (859)
│ │ │ │ ├── PGRN (938)
│ │ │ │ │ ├── PGRNd (970)
│ │ │ │ │ └── PGRNl (978)
│ │ │ │ ├── PHY (154)
│ │ │ │ │ ├── NR (177)
│ │ │ │ │ └── PRP (169)
│ │ │ │ ├── PPY (1069)
│ │ │ │ ├── VI (653)
│ │ │ │ ├── VII (661)
│ │ │ │ ├── VNC (701)
│ │ │ │ │ ├── LAV (209)
│ │ │ │ │ ├── MV (202)
│ │ │ │ │ ├── SPIV (225)
│ │ │ │ │ └── SUV (217)
│ │ │ │ ├── XII (773)
│ │ │ │ ├── x (765)
│ │ │ │ └── y (781)
│ │ │ ├── MY-sat (379)
│ │ │ │ ├── RM (206)
│ │ │ │ ├── RO (222)
│ │ │ │ └── RPA (230)
│ │ │ └── MY-sen (386)
│ │ │ ├── AP (207)
│ │ │ ├── CN (607)
│ │ │ │ ├── DCO (96)
│ │ │ │ └── VCO (101)
│ │ │ ├── DCN (720)
│ │ │ │ ├── CU (711)
│ │ │ │ └── GR (1039)
│ │ │ ├── ECU (903)
│ │ │ ├── NTB (642)
│ │ │ ├── NTS (651)
│ │ │ ├── Pa5 (589508451)
│ │ │ ├── SPVC (429)
│ │ │ ├── SPVI (437)
│ │ │ └── SPVO (445)
│ │ └── P (771)
│ │ ├── P-mot (987)
│ │ │ ├── Acs5 (549009219)
│ │ │ ├── B (280)
│ │ │ ├── DTN (880)
│ │ │ ├── I5 (549009227)
│ │ │ ├── P5 (549009215)
│ │ │ ├── PC5 (549009223)
│ │ │ ├── PCG (898)
│ │ │ ├── PDTg (599626927)
│ │ │ ├── PG (931)
│ │ │ ├── PRNc (1093)
│ │ │ ├── SG (318)
│ │ │ ├── SUT (534)
│ │ │ ├── TRN (574)
│ │ │ └── V (621)
│ │ ├── P-sat (1117)
│ │ │ ├── CS (679)
│ │ │ ├── LC (147)
│ │ │ ├── LDT (162)
│ │ │ ├── NI (604)
│ │ │ ├── PRNr (146)
│ │ │ ├── RPO (238)
│ │ │ ├── SLC (350)
│ │ │ └── SLD (358)
│ │ └── P-sen (1132)
│ │ ├── NLL (612)
│ │ ├── PB (867)
│ │ │ └── KF (123)
│ │ ├── PSV (7)
│ │ └── SOC (398)
│ │ ├── POR (122)
│ │ ├── SOCl (114)
│ │ └── SOCm (105)
│ ├── IB (1129)
│ │ ├── HY (1097)
│ │ │ ├── LZ (290)
│ │ │ │ ├── LHA (194)
│ │ │ │ ├── LPO (226)
│ │ │ │ ├── PST (356)
│ │ │ │ ├── PSTN (364)
│ │ │ │ ├── PeF (576073704)
│ │ │ │ ├── RCH (173)
│ │ │ │ ├── STN (470)
│ │ │ │ ├── TU (614)
│ │ │ │ └── ZI (797)
│ │ │ │ └── FF (804)
│ │ │ ├── ME (10671)
│ │ │ ├── MEZ (467)
│ │ │ │ ├── AHN (88)
│ │ │ │ ├── MBO (331)
│ │ │ │ │ ├── LM (210)
│ │ │ │ │ ├── MM (491)
│ │ │ │ │ │ ├── MMd (606826659)
│ │ │ │ │ │ ├── MMl (606826647)
│ │ │ │ │ │ ├── MMm (606826651)
│ │ │ │ │ │ ├── MMme (732)
│ │ │ │ │ │ └── MMp (606826655)
│ │ │ │ │ ├── SUM (525)
│ │ │ │ │ └── TM (557)
│ │ │ │ │ ├── TMd (1126)
│ │ │ │ │ └── TMv (1)
│ │ │ │ ├── MPN (515)
│ │ │ │ ├── PH (946)
│ │ │ │ ├── PMd (980)
│ │ │ │ ├── PMv (1004)
│ │ │ │ ├── PVHd (63)
│ │ │ │ └── VMH (693)
│ │ │ ├── PVR (141)
│ │ │ │ ├── ADP (72)
│ │ │ │ ├── AVP (263)
│ │ │ │ ├── AVPV (272)
│ │ │ │ ├── DMH (830)
│ │ │ │ ├── MEPO (452)
│ │ │ │ ├── MPO (523)
│ │ │ │ ├── OV (763)
│ │ │ │ ├── PD (914)
│ │ │ │ ├── PS (1109)
│ │ │ │ ├── PVp (126)
│ │ │ │ ├── PVpo (133)
│ │ │ │ ├── SBPV (347)
│ │ │ │ ├── SCH (286)
│ │ │ │ ├── SFO (338)
│ │ │ │ ├── VLPO (689)
│ │ │ │ └── VMPO (576073699)
│ │ │ └── PVZ (157)
│ │ │ ├── ARH (223)
│ │ │ ├── ASO (332)
│ │ │ ├── PVH (38)
│ │ │ ├── PVa (30)
│ │ │ ├── PVi (118)
│ │ │ └── SO (390)
│ │ └── TH (549)
│ │ ├── DORpm (856)
│ │ │ ├── ATN (239)
│ │ │ │ ├── AD (64)
│ │ │ │ ├── AM (127)
│ │ │ │ │ ├── AMd (1096)
│ │ │ │ │ └── AMv (1104)
│ │ │ │ ├── AV (255)
│ │ │ │ ├── IAD (1113)
│ │ │ │ ├── IAM (1120)
│ │ │ │ └── LD (155)
│ │ │ ├── EPI (958)
│ │ │ │ ├── LH (186)
│ │ │ │ └── MH (483)
│ │ │ ├── GENv (1014)
│ │ │ │ ├── IGL (27)
│ │ │ │ ├── IntG (563807439)
│ │ │ │ ├── LGv (178)
│ │ │ │ └── SubG (321)
│ │ │ ├── ILM (51)
│ │ │ │ ├── CL (575)
│ │ │ │ ├── CM (599)
│ │ │ │ ├── PCN (907)
│ │ │ │ ├── PF (930)
│ │ │ │ ├── PIL (560581563)
│ │ │ │ └── RH (189)
│ │ │ ├── LAT (138)
│ │ │ │ ├── Eth (560581551)
│ │ │ │ ├── LP (218)
│ │ │ │ ├── PO (1020)
│ │ │ │ ├── POL (1029)
│ │ │ │ └── SGN (325)
│ │ │ ├── MED (444)
│ │ │ │ ├── IMD (59)
│ │ │ │ ├── MD (362)
│ │ │ │ ├── PR (1077)
│ │ │ │ └── SMT (366)
│ │ │ ├── MTN (571)
│ │ │ │ ├── PT (15)
│ │ │ │ ├── PVT (149)
│ │ │ │ ├── RE (181)
│ │ │ │ └── Xi (560581559)
│ │ │ └── RT (262)
│ │ └── DORsm (864)
│ │ ├── GENd (1008)
│ │ │ ├── LGd (170)
│ │ │ │ ├── LGd-co (496345668)
│ │ │ │ ├── LGd-ip (496345672)
│ │ │ │ └── LGd-sh (496345664)
│ │ │ └── MG (475)
│ │ │ ├── MGd (1072)
│ │ │ ├── MGm (1088)
│ │ │ └── MGv (1079)
│ │ ├── PP (1044)
│ │ ├── SPA (609)
│ │ ├── SPF (406)
│ │ │ ├── SPFm (414)
│ │ │ └── SPFp (422)
│ │ └── VENT (637)
│ │ ├── PoT (563807435)
│ │ ├── VAL (629)
│ │ ├── VM (685)
│ │ └── VP (709)
│ │ ├── VPL (718)
│ │ ├── VPLpc (725)
│ │ ├── VPM (733)
│ │ └── VPMpc (741)
│ └── MB (313)
│ ├── MBmot (323)
│ │ ├── AT (231)
│ │ ├── CUN (616)
│ │ ├── DT (75)
│ │ ├── EW (975)
│ │ ├── III (35)
│ │ ├── IV (115)
│ │ ├── LT (66)
│ │ ├── MA3 (549009211)
│ │ ├── MRN (128)
│ │ ├── MT (58)
│ │ ├── PAG (795)
│ │ │ ├── INC (67)
│ │ │ ├── ND (587)
│ │ │ ├── PRC (50)
│ │ │ └── Su3 (614454277)
│ │ ├── PN (607344830)
│ │ ├── PRT (1100)
│ │ │ ├── APN (215)
│ │ │ ├── MPT (531)
│ │ │ ├── NOT (628)
│ │ │ ├── NPC (634)
│ │ │ ├── OP (706)
│ │ │ ├── PPT (1061)
│ │ │ └── RPF (549009203)
│ │ ├── Pa4 (606826663)
│ │ ├── RN (214)
│ │ ├── RR (246)
│ │ ├── SCm (294)
│ │ │ ├── SCdg (26)
│ │ │ ├── SCdw (42)
│ │ │ ├── SCig (10)
│ │ │ └── SCiw (17)
│ │ ├── SNr (381)
│ │ ├── VTA (749)
│ │ └── VTN (757)
│ ├── MBsen (339)
│ │ ├── IC (4)
│ │ │ ├── ICc (811)
│ │ │ ├── ICd (820)
│ │ │ └── ICe (828)
│ │ ├── MEV (460)
│ │ ├── NB (580)
│ │ ├── PBG (874)
│ │ ├── SAG (271)
│ │ ├── SCO (599626923)
│ │ └── SCs (302)
│ │ ├── SCop (851)
│ │ ├── SCsg (842)
│ │ └── SCzo (834)
│ └── MBsta (348)
│ ├── PPN (1052)
│ ├── RAmb (165)
│ │ ├── CLI (591)
│ │ ├── DR (872)
│ │ ├── IF (12)
│ │ ├── IPN (100)
│ │ │ ├── IPA (607344842)
│ │ │ ├── IPC (607344838)
│ │ │ ├── IPDL (607344858)
│ │ │ ├── IPDM (607344854)
│ │ │ ├── IPI (607344850)
│ │ │ ├── IPL (607344846)
│ │ │ ├── IPR (607344834)
│ │ │ └── IPRL (607344862)
│ │ └── RL (197)
│ └── SNc (374)
├── CB (512)
│ ├── CBN (519)
│ │ ├── DN (846)
│ │ ├── FN (989)
│ │ ├── IP (91)
│ │ └── VeCB (589508455)
│ └── CBX (528)
│ ├── HEM (1073)
│ │ ├── AN (1017)
│ │ │ ├── ANcr1 (1056)
│ │ │ └── ANcr2 (1064)
│ │ ├── COPY (1033)
│ │ ├── FL (1049)
│ │ ├── PFL (1041)
│ │ ├── PRM (1025)
│ │ └── SIM (1007)
│ └── VERM (645)
│ ├── CENT (920)
│ │ ├── CENT2 (976)
│ │ └── CENT3 (984)
│ ├── CUL (928)
│ │ └── CUL4, 5 (1091)
│ ├── DEC (936)
│ ├── FOTU (944)
│ ├── LING (912)
│ ├── NOD (968)
│ ├── PYR (951)
│ └── UVU (957)
└── CH (567)
├── CNU (623)
│ ├── PAL (803)
│ │ ├── PALc (809)
│ │ │ ├── BAC (287)
│ │ │ └── BST (351)
│ │ ├── PALd (818)
│ │ │ ├── GPe (1022)
│ │ │ └── GPi (1031)
│ │ ├── PALm (826)
│ │ │ ├── MSC (904)
│ │ │ │ ├── MS (564)
│ │ │ │ └── NDB (596)
│ │ │ └── TRS (581)
│ │ └── PALv (835)
│ │ ├── MA (298)
│ │ └── SI (342)
│ └── STR (477)
│ ├── LSX (275)
│ │ ├── LS (242)
│ │ │ ├── LSc (250)
│ │ │ ├── LSr (258)
│ │ │ └── LSv (266)
│ │ ├── SF (310)
│ │ └── SH (333)
│ ├── STRd (485)
│ │ └── CP (672)
│ ├── STRv (493)
│ │ ├── ACB (56)
│ │ ├── FS (998)
│ │ └── OT (754)
│ └── sAMY (278)
│ ├── AAA (23)
│ ├── BA (292)
│ ├── CEA (536)
│ │ ├── CEAc (544)
│ │ ├── CEAl (551)
│ │ └── CEAm (559)
│ ├── IA (1105)
│ └── MEA (403)
└── CTX (688)
├── CTXpl (695)
│ ├── HPF (1089)
│ │ ├── HIP (1080)
│ │ │ ├── CA (375)
│ │ │ │ ├── CA1 (382)
│ │ │ │ ├── CA2 (423)
│ │ │ │ └── CA3 (463)
│ │ │ ├── DG (726)
│ │ │ │ ├── DG-mo (10703)
│ │ │ │ ├── DG-po (10704)
│ │ │ │ └── DG-sg (632)
│ │ │ ├── FC (982)
│ │ │ └── IG (19)
│ │ └── RHP (822)
│ │ ├── APr (484682508)
│ │ ├── ENT (909)
│ │ │ ├── ENTl (918)
│ │ │ │ ├── ENTl1 (1121)
│ │ │ │ ├── ENTl2 (20)
│ │ │ │ ├── ENTl3 (52)
│ │ │ │ ├── ENTl5 (139)
│ │ │ │ └── ENTl6a (28)
│ │ │ └── ENTm (926)
│ │ │ ├── ENTm1 (526)
│ │ │ ├── ENTm2 (543)
│ │ │ ├── ENTm3 (664)
│ │ │ ├── ENTm5 (727)
│ │ │ └── ENTm6 (743)
│ │ ├── HATA (589508447)
│ │ ├── PAR (843)
│ │ ├── POST (1037)
│ │ ├── PRE (1084)
│ │ ├── ProS (484682470)
│ │ └── SUB (502)
│ ├── Isocortex (315)
│ │ ├── ACA (31)
│ │ │ ├── ACAd (39)
│ │ │ │ ├── ACAd1 (935)
│ │ │ │ ├── ACAd2/3 (211)
│ │ │ │ ├── ACAd5 (1015)
│ │ │ │ ├── ACAd6a (919)
│ │ │ │ └── ACAd6b (927)
│ │ │ └── ACAv (48)
│ │ │ ├── ACAv1 (588)
│ │ │ ├── ACAv2/3 (296)
│ │ │ ├── ACAv5 (772)
│ │ │ ├── ACAv6a (810)
│ │ │ └── ACAv6b (819)
│ │ ├── AI (95)
│ │ │ ├── AId (104)
│ │ │ │ ├── AId1 (996)
│ │ │ │ ├── AId2/3 (328)
│ │ │ │ ├── AId5 (1101)
│ │ │ │ ├── AId6a (783)
│ │ │ │ └── AId6b (831)
│ │ │ ├── AIp (111)
│ │ │ │ ├── AIp1 (120)
│ │ │ │ ├── AIp2/3 (163)
│ │ │ │ ├── AIp5 (344)
│ │ │ │ ├── AIp6a (314)
│ │ │ │ └── AIp6b (355)
│ │ │ └── AIv (119)
│ │ │ ├── AIv1 (704)
│ │ │ ├── AIv2/3 (694)
│ │ │ ├── AIv5 (800)
│ │ │ ├── AIv6a (675)
│ │ │ └── AIv6b (699)
│ │ ├── AUD (247)
│ │ │ ├── AUDd (1011)
│ │ │ │ ├── AUDd1 (527)
│ │ │ │ ├── AUDd2/3 (600)
│ │ │ │ ├── AUDd4 (678)
│ │ │ │ ├── AUDd5 (252)
│ │ │ │ ├── AUDd6a (156)
│ │ │ │ └── AUDd6b (243)
│ │ │ ├── AUDp (1002)
│ │ │ │ ├── AUDp1 (735)
│ │ │ │ ├── AUDp2/3 (251)
│ │ │ │ ├── AUDp4 (816)
│ │ │ │ ├── AUDp5 (847)
│ │ │ │ ├── AUDp6a (954)
│ │ │ │ └── AUDp6b (1005)
│ │ │ ├── AUDpo (1027)
│ │ │ │ ├── AUDpo1 (696)
│ │ │ │ ├── AUDpo2/3 (643)
│ │ │ │ ├── AUDpo4 (759)
│ │ │ │ ├── AUDpo5 (791)
│ │ │ │ ├── AUDpo6a (249)
│ │ │ │ └── AUDpo6b (456)
│ │ │ └── AUDv (1018)
│ │ │ ├── AUDv1 (959)
│ │ │ ├── AUDv2/3 (755)
│ │ │ ├── AUDv4 (990)
│ │ │ ├── AUDv5 (1023)
│ │ │ ├── AUDv6a (520)
│ │ │ └── AUDv6b (598)
│ │ ├── ECT (895)
│ │ │ ├── ECT1 (836)
│ │ │ ├── ECT2/3 (427)
│ │ │ ├── ECT5 (988)
│ │ │ ├── ECT6a (977)
│ │ │ └── ECT6b (1045)
│ │ ├── FRP (184)
│ │ │ ├── FRP1 (68)
│ │ │ ├── FRP2/3 (667)
│ │ │ ├── FRP5 (526157192)
│ │ │ ├── FRP6a (526157196)
│ │ │ └── FRP6b (526322264)
│ │ ├── GU (1057)
│ │ │ ├── GU1 (36)
│ │ │ ├── GU2/3 (180)
│ │ │ ├── GU4 (148)
│ │ │ ├── GU5 (187)
│ │ │ ├── GU6a (638)
│ │ │ └── GU6b (662)
│ │ ├── ILA (44)
│ │ │ ├── ILA1 (707)
│ │ │ ├── ILA2/3 (556)
│ │ │ ├── ILA5 (827)
│ │ │ ├── ILA6a (1054)
│ │ │ └── ILA6b (1081)
│ │ ├── MO (500)
│ │ │ ├── MOp (985)
│ │ │ │ ├── MOp1 (320)
│ │ │ │ ├── MOp2/3 (943)
│ │ │ │ ├── MOp5 (648)
│ │ │ │ ├── MOp6a (844)
│ │ │ │ └── MOp6b (882)
│ │ │ └── MOs (993)
│ │ │ ├── MOs1 (656)
│ │ │ ├── MOs2/3 (962)
│ │ │ ├── MOs5 (767)
│ │ │ ├── MOs6a (1021)
│ │ │ └── MOs6b (1085)
│ │ ├── ORB (714)
│ │ │ ├── ORBl (723)
│ │ │ │ ├── ORBl1 (448)
│ │ │ │ ├── ORBl2/3 (412)
│ │ │ │ ├── ORBl5 (630)
│ │ │ │ ├── ORBl6a (440)
│ │ │ │ └── ORBl6b (488)
│ │ │ ├── ORBm (731)
│ │ │ │ ├── ORBm1 (484)
│ │ │ │ ├── ORBm2/3 (582)
│ │ │ │ ├── ORBm5 (620)
│ │ │ │ ├── ORBm6a (910)
│ │ │ │ └── ORBm6b (527696977)
│ │ │ └── ORBvl (746)
│ │ │ ├── ORBvl1 (969)
│ │ │ ├── ORBvl2/3 (288)
│ │ │ ├── ORBvl5 (1125)
│ │ │ ├── ORBvl6a (608)
│ │ │ └── ORBvl6b (680)
│ │ ├── PERI (922)
│ │ │ ├── PERI1 (540)
│ │ │ ├── PERI2/3 (888)
│ │ │ ├── PERI5 (692)
│ │ │ ├── PERI6a (335)
│ │ │ └── PERI6b (368)
│ │ ├── PL (972)
│ │ │ ├── PL1 (171)
│ │ │ ├── PL2/3 (304)
│ │ │ ├── PL5 (363)
│ │ │ ├── PL6a (84)
│ │ │ └── PL6b (132)
│ │ ├── PTLp (22)
│ │ │ ├── VISa (312782546)
│ │ │ │ ├── VISa1 (312782550)
│ │ │ │ ├── VISa2/3 (312782554)
│ │ │ │ ├── VISa4 (312782558)
│ │ │ │ ├── VISa5 (312782562)
│ │ │ │ ├── VISa6a (312782566)
│ │ │ │ └── VISa6b (312782570)
│ │ │ └── VISrl (417)
│ │ │ ├── VISrl1 (312782604)
│ │ │ ├── VISrl2/3 (312782608)
│ │ │ ├── VISrl4 (312782612)
│ │ │ ├── VISrl5 (312782616)
│ │ │ ├── VISrl6a (312782620)
│ │ │ └── VISrl6b (312782624)
│ │ ├── RSP (254)
│ │ │ ├── RSPagl (894)
│ │ │ │ ├── RSPagl1 (671)
│ │ │ │ ├── RSPagl2/3 (965)
│ │ │ │ ├── RSPagl5 (774)
│ │ │ │ ├── RSPagl6a (906)
│ │ │ │ └── RSPagl6b (279)
│ │ │ ├── RSPd (879)
│ │ │ │ ├── RSPd1 (442)
│ │ │ │ ├── RSPd2/3 (434)
│ │ │ │ ├── RSPd4 (545)
│ │ │ │ ├── RSPd5 (610)
│ │ │ │ ├── RSPd6a (274)
│ │ │ │ └── RSPd6b (330)
│ │ │ └── RSPv (886)
│ │ │ ├── RSPv1 (542)
│ │ │ ├── RSPv2/3 (430)
│ │ │ ├── RSPv5 (687)
│ │ │ ├── RSPv6a (590)
│ │ │ └── RSPv6b (622)
│ │ ├── SS (453)
│ │ │ ├── SSp (322)
│ │ │ │ ├── SSp-bfd (329)
│ │ │ │ │ ├── SSp-bfd1 (981)
│ │ │ │ │ ├── SSp-bfd2/3 (201)
│ │ │ │ │ ├── SSp-bfd4 (1047)
│ │ │ │ │ ├── SSp-bfd5 (1070)
│ │ │ │ │ ├── SSp-bfd6a (1038)
│ │ │ │ │ └── SSp-bfd6b (1062)
│ │ │ │ ├── SSp-ll (337)
│ │ │ │ │ ├── SSp-ll1 (1030)
│ │ │ │ │ ├── SSp-ll2/3 (113)
│ │ │ │ │ ├── SSp-ll4 (1094)
│ │ │ │ │ ├── SSp-ll5 (1128)
│ │ │ │ │ ├── SSp-ll6a (478)
│ │ │ │ │ └── SSp-ll6b (510)
│ │ │ │ ├── SSp-m (345)
│ │ │ │ │ ├── SSp-m1 (878)
│ │ │ │ │ ├── SSp-m2/3 (657)
│ │ │ │ │ ├── SSp-m4 (950)
│ │ │ │ │ ├── SSp-m5 (974)
│ │ │ │ │ ├── SSp-m6a (1102)
│ │ │ │ │ └── SSp-m6b (2)
│ │ │ │ ├── SSp-n (353)
│ │ │ │ │ ├── SSp-n1 (558)
│ │ │ │ │ ├── SSp-n2/3 (838)
│ │ │ │ │ ├── SSp-n4 (654)
│ │ │ │ │ ├── SSp-n5 (702)
│ │ │ │ │ ├── SSp-n6a (889)
│ │ │ │ │ └── SSp-n6b (929)
│ │ │ │ ├── SSp-tr (361)
│ │ │ │ │ ├── SSp-tr1 (1006)
│ │ │ │ │ ├── SSp-tr2/3 (670)
│ │ │ │ │ ├── SSp-tr4 (1086)
│ │ │ │ │ ├── SSp-tr5 (1111)
│ │ │ │ │ ├── SSp-tr6a (9)
│ │ │ │ │ └── SSp-tr6b (461)
│ │ │ │ ├── SSp-ul (369)
│ │ │ │ │ ├── SSp-ul1 (450)
│ │ │ │ │ ├── SSp-ul2/3 (854)
│ │ │ │ │ ├── SSp-ul4 (577)
│ │ │ │ │ ├── SSp-ul5 (625)
│ │ │ │ │ ├── SSp-ul6a (945)
│ │ │ │ │ └── SSp-ul6b (1026)
│ │ │ │ └── SSp-un (182305689)
│ │ │ │ ├── SSp-un1 (182305693)
│ │ │ │ ├── SSp-un2/3 (182305697)
│ │ │ │ ├── SSp-un4 (182305701)
│ │ │ │ ├── SSp-un5 (182305705)
│ │ │ │ ├── SSp-un6a (182305709)
│ │ │ │ └── SSp-un6b (182305713)
│ │ │ └── SSs (378)
│ │ │ ├── SSs1 (873)
│ │ │ ├── SSs2/3 (806)
│ │ │ ├── SSs4 (1035)
│ │ │ ├── SSs5 (1090)
│ │ │ ├── SSs6a (862)
│ │ │ └── SSs6b (893)
│ │ ├── TEa (541)
│ │ │ ├── TEa1 (97)
│ │ │ ├── TEa2/3 (1127)
│ │ │ ├── TEa4 (234)
│ │ │ ├── TEa5 (289)
│ │ │ ├── TEa6a (729)
│ │ │ └── TEa6b (786)
│ │ ├── VIS (669)
│ │ │ ├── VISal (402)
│ │ │ │ ├── VISal1 (1074)
│ │ │ │ ├── VISal2/3 (905)
│ │ │ │ ├── VISal4 (1114)
│ │ │ │ ├── VISal5 (233)
│ │ │ │ ├── VISal6a (601)
│ │ │ │ └── VISal6b (649)
│ │ │ ├── VISam (394)
│ │ │ │ ├── VISam1 (281)
│ │ │ │ ├── VISam2/3 (1066)
│ │ │ │ ├── VISam4 (401)
│ │ │ │ ├── VISam5 (433)
│ │ │ │ ├── VISam6a (1046)
│ │ │ │ └── VISam6b (441)
│ │ │ ├── VISl (409)
│ │ │ │ ├── VISl1 (421)
│ │ │ │ ├── VISl2/3 (973)
│ │ │ │ ├── VISl4 (573)
│ │ │ │ ├── VISl5 (613)
│ │ │ │ ├── VISl6a (74)
│ │ │ │ └── VISl6b (121)
│ │ │ ├── VISli (312782574)
│ │ │ │ ├── VISli1 (312782578)
│ │ │ │ ├── VISli2/3 (312782582)
│ │ │ │ ├── VISli4 (312782586)
│ │ │ │ ├── VISli5 (312782590)
│ │ │ │ ├── VISli6a (312782594)
│ │ │ │ └── VISli6b (312782598)
│ │ │ ├── VISp (385)
│ │ │ │ ├── VISp1 (593)
│ │ │ │ ├── VISp2/3 (821)
│ │ │ │ ├── VISp4 (721)
│ │ │ │ ├── VISp5 (778)
│ │ │ │ ├── VISp6a (33)
│ │ │ │ └── VISp6b (305)
│ │ │ ├── VISpl (425)
│ │ │ │ ├── VISpl1 (750)
│ │ │ │ ├── VISpl2/3 (269)
│ │ │ │ ├── VISpl4 (869)
│ │ │ │ ├── VISpl5 (902)
│ │ │ │ ├── VISpl6a (377)
│ │ │ │ └── VISpl6b (393)
│ │ │ ├── VISpm (533)
│ │ │ │ ├── VISpm1 (805)
│ │ │ │ ├── VISpm2/3 (41)
│ │ │ │ ├── VISpm4 (501)
│ │ │ │ ├── VISpm5 (565)
│ │ │ │ ├── VISpm6a (257)
│ │ │ │ └── VISpm6b (469)
│ │ │ └── VISpor (312782628)
│ │ │ ├── VISpor1 (312782632)
│ │ │ ├── VISpor2/3 (312782636)
│ │ │ ├── VISpor4 (312782640)
│ │ │ ├── VISpor5 (312782644)
│ │ │ ├── VISpor6a (312782648)
│ │ │ └── VISpor6b (312782652)
│ │ └── VISC (677)
│ │ ├── VISC1 (897)
│ │ ├── VISC2/3 (1106)
│ │ ├── VISC4 (1010)
│ │ ├── VISC5 (1058)
│ │ ├── VISC6a (857)
│ │ └── VISC6b (849)
│ └── OLF (698)
│ ├── AOB (151)
│ │ ├── AOBgl (188)
│ │ ├── AOBgr (196)
│ │ └── AOBmi (204)
│ ├── AON (159)
│ ├── COA (631)
│ │ ├── COAa (639)
│ │ └── COAp (647)
│ │ ├── COApl (655)
│ │ └── COApm (663)
│ ├── DP (814)
│ ├── MOB (507)
│ ├── NLOT (619)
│ │ ├── NLOT1 (260)
│ │ ├── NLOT2 (268)
│ │ └── NLOT3 (1139)
│ ├── PAA (788)
│ ├── PIR (961)
│ ├── TR (566)
│ └── TT (589)
│ ├── TTd (597)
│ └── TTv (605)
└── CTXsp (703)
├── BLA (295)
│ ├── BLAa (303)
│ ├── BLAp (311)
│ └── BLAv (451)
├── BMA (319)
│ ├── BMAa (327)
│ └── BMAp (334)
├── CLA (583)
├── EP (942)
│ ├── EPd (952)
│ └── EPv (966)
├── LA (131)
└── PA (780)
"""
from typing import Literal
from typing_extensions import TypeAlias
from neuralib.typing import Series
from .typing import Area, MergeLevel
__all__ = ['NUM_MERGE_LAYER',
'MERGE_REGION_LV4',
'MERGE_REGION_LV3',
'MERGE_REGION_LV2',
'MERGE_REGION_LV1',
'MERGE_REGION_LV0',
#
'DEFAULT_FAMILY_DICT',
'ALLEN_FAMILY_TYPE',
'TH_FAMILY',
'ISOCORTEX_FAMILY',
'HPF_FAMILY',
#
'merge_until_level']
NUM_MERGE_LAYER = 5
# =========================== #
# LEVEL 4: Mainly Merge layer #
# =========================== #
MERGE_LEVEL_LAYER: MergeLevel = 4
MERGE_REGION_LV4 = {
# VS
'VL': ['SEZ', 'chpl'],
'V4': ['V4r'],
# CB
'AN': ['ANcr1', 'ANcr2'],
'CENT': ['CENT*'],
'CUL': ['CUL*'],
# HPF
'ENTl': ['ENTl*'],
'ENTm': ['ENTm*'],
# Isocortex
'ACAd': ['ACAd*'],
'ACAv': ['ACAv*'],
'AId': ['AId*'],
'AIp': ['AIp*'],
'AIv': ['AIv*'],
'AUDd': ['AUDd*'],
'AUDp': ['AUDp*'],
'AUDpo': ['AUDpo*'],
'AUDv': ['AUDv*'],
'ECT': ['ECT*'],
'FRP': ['FRP*'],
'GU': ['GU*'],
'ILA': ['ILA*'],
'MOp': ['MOp*'],
'MOs': ['MOs*'],
'ORBl': ['ORBl*'],
'ORBm': ['ORBm*'],
'ORBvl': ['ORBvl*'],
'PERI': ['PERI*'],
'PL': ['PL*'],
'VISa': ['VISa1', 'VISa2/3', 'VISa4', 'VISa5', 'VISa6a', 'VISa6b'], # NOTE PTLp child
'VISrl': ['VISrl*'],
'RSPagl': ['RSPagl*'],
'RSPd': ['RSPd*'],
'RSPv': ['RSPv*'],
'SSs-bfd': ['SSs-bfd*'],
'SSp-ll': ['SSp-ll*'],
'SSp-m': ['SSp-m*'],
'SSp-n': ['SSp-n*'],
'SSp-tr': ['SSp-tr*'],
'SSp-ul': ['SSp-ul*'],
'SSp-un': ['SSp-un*'],
'SSs': ['SSs*'],
'TEa': ['TEa*'],
'VISal': ['VISal*'],
'VISam': ['VISam*'],
'VISl': ['VISl1', 'VISl2/3', 'VISl4', 'VISl5', 'VISl6a', 'VISl6b'], # differentiate the VISli
'VISli': ['VISli*'],
'VISp': ['VISp1', 'VISp2/3', 'VISp4', 'VISp5', 'VISp6a', 'VISp6b'], # differentiate VISpl, VISpm
'VISpl': ['VISpl*'],
'VISpm': ['VISpm*'],
'VISpor': ['VISpor*'],
'VISC': ['VISC*'],
# OLF
'NLOT': ['NLOT*']
}
# ============================== #
# LEVEL 3: Mainly merge DV ML AP #
# ============================== #
MERGE_LEVEL_DVMLAP: MergeLevel = 3
MERGE_REGION_LV3 = {
# HB
'AMB': ['AMB*'],
'LRN': ['LRN*'],
'MDRN': ['MDRN*'],
'PGRN': ['PGRN*'],
'SOC': ['POR', 'SOC*'],
# HY
'MM': ['MMd', 'MMl', 'MMm', 'MMme', 'MMp',
'Mmd', 'Mml', 'Mmm', 'Mmme', 'Mmp'], # diff in ccf
'TM': ['TM*'],
# TH
'AM': ['AM*'],
'LGd': ['LGd-*'],
'MG': ['MG*'],
'SPF': ['SPF*'],
'VP': ['VPL', 'VPLpc', 'VPM', 'VPMpc'],
# HPF
'ENT': ['ENT*'],
'DG': ['DG*'],
# Isocortex
'ACA': ['ACA*'],
'AI': ['AId', 'AIp', 'AIv'],
'AUD': ['AUD*'],
'ORB': ['ORBl', 'ORBm', 'ORBvl'],
'SSp': ['SSp*'],
'AOB': ['AOB*'],
'COA': ['COA*'],
'TT': ['TT*'],
# CNU
'PALc': ['BAC', 'BST'],
'PALd': ['GPe', 'GPi'],
'MSC': ['MS', 'NDB'],
'PALv': ['MA', 'SI'],
'LS': ['LSc', 'LSr', 'LSv'],
'CEA': ['CEA*'],
# MB
'SCm': ['SCdg', 'SCdw', 'SCig', 'SCiw'],
'IC': ['IC*'],
'SCs': ['SCop', 'SCsg', 'SCzo'],
# CTXsp
'BLA': ['BLA*'],
'BMA': ['BMA*'],
'EP': ['EP*'],
}
# ========================= #
# LEVEL 2: Customized Merge #
# ========================= #
MERGE_LEVEL_C2: MergeLevel = 2
MERGE_REGION_LV2 = {
# HPF
'CA': ['CA1', 'CA2', 'CA3'],
'SUB': ['ProS'], # might not correct, converge due to the area not in cellatlas (Prosubiculum)
# Isocortex
'SS': ['SS*'],
'VIS': ['VISal', 'VISam', 'VISl', 'VISli', 'VISp', 'VISpl', 'VISpm', 'VISpor'],
'PTLp': ['VISa', 'VISrl'],
'MO': ['MOp', 'MOs'],
'RSP': ['RSP*'],
# TH
'ATN': ['AD', 'AM', 'AV', 'IAD', 'IAM', 'LD'],
'EPI': ['LH', 'MH'],
'GENv': ['IGL', 'IntG', 'LGv', 'SubG'],
'ILM': ['CL', 'CM', 'PCN', 'PF', 'PIL', 'RH'],
'LAT': ['Eth', 'LP', 'PO', 'POL', 'SGN'],
'MED': ['IMD', 'MD', 'PR', 'SMT'],
'MTN': ['PT', 'PVT', 'RE', 'Xi'],
'GENd': ['LGd', 'MG'],
'VENT': ['PoT', 'VAL', 'VM', 'VP'],
# CNU
'PALm': ['MSC', 'TRS'],
'LSX': ['LS', 'SF', 'SH'],
'STRd': ['CP'],
'STRv': ['ACB', 'FS', 'OT'],
'sAMY': ['AAA', 'BA', 'CEA', 'IA', 'MEA'],
# HY
'MBO': ['LM', 'MM', 'SUM', 'TM'],
'ZI': ['FF'],
# MB
'IPN': ['IPA', 'IPC', 'IPDL', 'IPDM', 'IPI', 'IPL', 'IPR', 'IPRL'],
# HB
'PHY': ['NR', 'PRP'],
'VNC': ['LAV', 'MV', 'SPIV', 'SUV'],
'CN': ['DCO', 'VCO'],
'DCN': ['CU', 'GR'],
'PB': ['KF'],
# CB
'HEM': ['AN', 'COPY', 'FL', 'PFL', 'PRM', 'SIM'],
'VERM': ['CENT', 'CUL', 'DEC', 'FOTU', 'LING', 'NOD', 'PYR', 'UVU'],
}
# ========================= #
# LEVEL 1: Customized Merge #
# ========================= #
MERGE_LEVEL_C1: MergeLevel = 1
MERGE_REGION_LV1 = {
# VS
'VS': ['AQ', 'V3', 'V4', 'VL'],
# OLF
'OLF': ['AOB', 'AON', 'COA', 'DP', 'MOB', 'NLOT', 'PAA', 'PIR', 'TR', 'TT'],
# HPF
'HIP': ['CA', 'DG', 'FC', 'IG'],
'RHP': ['APr', 'ENT', 'HATA', 'PAR', 'POST', 'PRE', 'ProS', 'SUB'],
# CNU
'PAL': ['PALc', 'PALd', 'PALm', 'PALv'],
'STR': ['LSX', 'STRd', 'STRv', 'sAMY'],
# HY
'LZ': ['LHA', 'LPO', 'PST', 'PSTN', 'PeF', 'RCH', 'STN', 'TU', 'ZI'],
'MEZ': ['AHN', 'MBO', 'MPN', 'PH', 'PMd', 'PMv', 'PVHd', 'VMH'],
'PVR': ['ADP', 'AVP', 'AVPV', 'DMH', 'MEPO', 'MPO', 'OV', 'PD', 'PS', 'PVp', 'PVpo', 'SBPV', 'SCH', 'SFO', 'VLPO',
'VMPO'],
'PVZ': ['ARH', 'ASO', 'PVH', 'PVa', 'PVi', 'SO'],
# MB
'PAG': ['INC', 'ND', 'PRC', 'Su3'],
'PRT': ['APN', 'MPT', 'NOT', 'NPC', 'OP', 'PPT', 'RPF'],
'RAmb': ['CLI', 'DR', 'IF', 'IPN', 'RL']
}
# ========================= #
# LEVEL 0: Customized Merge #
# ========================= #
MERGE_LEVEL_C0: MergeLevel = 0
MERGE_REGION_LV0 = {
# HB
'MY-mot': ['ACVII', 'AMB', 'DMX', 'GRN', 'ICB', 'IO', 'IRN', 'ISN', 'LIN', 'LRN', 'MARN', 'MDRN', 'PARN', 'PAS',
'PGRN', 'PHY', 'PPY', 'VI', 'VII', 'VNC', 'XII', 'x', 'y'],
'MY-sat': ['RM', 'RO', 'RPA'],
'MY-sen': ['AP', 'CN', 'DCN', 'ECU', 'NTB', 'NTS', 'PA5', 'SPVC', 'SPVI', 'SPVO'],
'P-mot': ['Acs5', 'B', 'DTN', 'I5', 'P5', 'PC5', 'PCG', 'PDTg', 'PG', 'PRNc', 'SG', 'SUT', 'TRN', 'V'],
'P-sat': ['CS', 'LC', 'LDT', 'NI', 'PRNr', 'RPO', 'SLC', 'SLD'],
'P-sen': ['NLL', 'PB', 'PSV', 'SOC'],
#
'HPF': ['HIP', 'RHP'],
#
'HY': ['LZ', 'ME', 'MEZ', 'PVR', 'PVZ'],
#
'TH': ['ATN', 'EPI', 'GENv', 'ILM', 'LAT', 'MED', 'MTN', 'RT', # DORpm
'GENd', 'PP', 'SPA', 'SPF', 'VENT'], # DORsm
# MB
'MBmot': ['AT', 'CUN', 'DT', 'EW', 'III', 'IV', 'LT', 'MA3', 'MRN', 'MT', 'PAG',
'PN', 'PRT', 'Pa4', 'RN', 'RR', 'SCm', 'SNr', 'VTA', 'VTN'],
'MBsen': ['IC', 'MEV', 'NB', 'PBG', 'SAG', 'SCO', 'SCs'],
'MBsta': ['PPN', 'RAmb', 'SNc'],
# CB
'CBN': ['DN', 'FN', 'IP', 'VeCB'],
'CBX': ['HEM', 'VERM']
}
# ==================================================================================== #
# Grey matter Family (i.e., Used after merging, assume already converge(merge) enough) #
# ==================================================================================== #
ALLEN_FAMILY_TYPE = Literal['HB', 'HY', 'TH', 'MB', 'CB', 'CTXpl', 'HPF', 'ISOCORTEX', 'OLF', 'CTXsp']
AllenFamilyType: TypeAlias = tuple[Area, ...]
# VS
VS_FAMILY: AllenFamilyType = ('VS',)
# HB
HB_FAMILY: AllenFamilyType = ('MY-mot', 'MY-sat', 'MY-sen', 'P-mot', 'P-sat', 'P-sen')
# HY
HY_FAMILY: AllenFamilyType = ('HY',)
# TH
TH_FAMILY: AllenFamilyType = ('TH',)
# MB (`MB` initially show in ccf map)
MB_FAMILY: AllenFamilyType = ('MB', 'MBmot', 'MBsen', 'MBsta')
# CB
CB_FAMILY: AllenFamilyType = ('CBN', 'CBX')
# CNU
CNU_FAMILY: AllenFamilyType = ('PAL', 'STR')
# CTXpl
HPF_FAMILY: AllenFamilyType = ('HPF',)
ISOCORTEX_FAMILY: AllenFamilyType = (
'ACA', 'AI', 'AUD', 'ECT', 'FRP', 'GU', 'ILA', 'MO', 'ORB', 'PERI', 'PL', 'PTLp', 'RSP',
'SS', 'TEa', 'VIS', 'VISC'
)
OLF_FAMILY: AllenFamilyType = ('OLF',)
CTXPL_FAMILY = HPF_FAMILY + ISOCORTEX_FAMILY + OLF_FAMILY
# CTXsp
CTXSP_FAMILY: AllenFamilyType = ('CTXsp', 'BLA', 'BMA', 'CLA', 'EP', 'LA', 'PA')
DEFAULT_FAMILY_DICT: dict[str, AllenFamilyType] = dict(
VS=VS_FAMILY,
HB=HB_FAMILY,
HY=HY_FAMILY,
TH=TH_FAMILY,
MB=MB_FAMILY,
CB=CB_FAMILY,
CNU=CNU_FAMILY,
HPF=HPF_FAMILY,
ISOCORTEX=ISOCORTEX_FAMILY,
OLF=OLF_FAMILY,
CTXSP=CTXSP_FAMILY
)
# ============== #
# Implementation #
# ============== #
def merge_area(ps: Series, region: dict[str, list[Area]]) -> list[str]:
"""
merge the area name series to another level based on the ``region`` dict
:param ps: pandas/polars series with area name
:param region: ``MERGE_REGION_LV*``
:return:
"""
ret = []
for a in ps:
ret.append(_merge_area(a, region))
return ret
def _merge_area(s: str, region: dict[str, list[Area]]) -> str:
"""
:param s: individual `acronym` value
:param region:
:return:
"""
for n, p in region.items():
for pattern in p:
if pattern.endswith('*'):
if s.startswith(pattern[:-1]):
return n
elif pattern == s:
return n
return s
[docs]
def merge_until_level(ps: Series, level: MergeLevel) -> list[Area]:
"""
merge the area until which `level`
:param ps: pandas/polars series with area name
:param level: level int
:return: list of area
"""
if level not in list(range(NUM_MERGE_LAYER)):
raise ValueError(f'wrong level: {level}')
if level <= MERGE_LEVEL_LAYER:
ps = merge_area(ps, MERGE_REGION_LV4)
if level <= MERGE_LEVEL_DVMLAP:
ps = merge_area(ps, MERGE_REGION_LV3)
if level <= MERGE_LEVEL_C2:
ps = merge_area(ps, MERGE_REGION_LV2)
if level <= MERGE_LEVEL_C1:
ps = merge_area(ps, MERGE_REGION_LV1)
if level <= MERGE_LEVEL_C0:
ps = merge_area(ps, MERGE_REGION_LV0)
return ps