rh@ 4SrSSKJr SSKrSSKrSSKJr SSKrSSK J r SSK J r SSK J r SSK Jr SS K Jr SS K Jr SS KJr \ R&"S 5r\"S /SQ5r\"S/SQ5r"SS\ R.5r"SS\5r"SS\5r"SS\5r"SS\5r"SS\R:5r"SS\R>5r "SS \RB5r"S0S1S"jjr#S#r$S$r%S2S&jr&"S'S!\RN5r("S(S%\RN5r)"S)S*\RT5r+"S+S,\RX5r-\\\\\\(\)\+\-/ r."S-S.\R^5r0\1S/:XaSSK r \ Rd"\05 gg)3a The layout.py module contains two types of objects that specify the layout on page (or screen) for Scores and other Stream objects. There are two main types of Layout objects: (1) layout describing elements and (2) layout defining Streams. (1) ScoreLayout, PageLayout, SystemLayout, and StaffLayout objects describe the size of pages, the geometry of page and system margins, the distance between staves, etc. The model for these layout objects is taken directly (perhaps too directly?) from MusicXML. These objects all inherit from a BaseLayout class, primarily as an aid to finding all of these objects as a group. ScoreLayouts give defaults for each page, system, and staff. Thus, they contain PageLayout, SystemLayout, and currently one or more StaffLayout objects (but probably just one. MusicXML allows more than StaffLayout object because multiple staves can be in a Part. Music21 uses the concept of a PartStaff for a Part that is played by the same performer as another. e.g., the left hand of the Piano is a PartStaff paired with the right hand). PageLayout and SystemLayout objects also have a property, 'isNew', which, if set to `True`, signifies that a new page or system should begin here. In theory, one could define new dimensions for a page or system in the middle of the system or page without setting isNew to True, in which case these measurements would start applying on the next page. In practice, there's really one good place to use these Layout objects and that's in the first part in a score at offset 0 of the first measure on a page or system (or for ScoreLayout, at the beginning of a piece outside any parts). But it's not an error to put them in other places, such as at offset 0 of the first measure of a page or system in all the other parts. In fact, MusicXML tends to do this, and it ends up not being a waste if a program extracts a single part from the middle of a score. These objects are standard :class:`~music21.base.Music21Object` types, but many properties such as .duration, .beat, will probably not apply. When exporting to MusicXML (which is currently the only format in which music21 can and does preserve these markings), many MusicXML readers will ignore these tags (or worse, add a new page or system when PageLayout and SystemLayout objects are found but also add theme wherever they want). In Finale, this behavior disappears if the MusicXML document notes that it new-page and new-system markings. Music21 will add the appropriate tags if the containing Stream has `.definesExplicitPageBreaks` and `.definesExplicitSystemBreaks` set to True. When importing a score that has the tag set, music21 will set `.definesExplicitXXXXBreaks` to True for the outer score and the inner parts. However, this means that if the score is manipulated enough that the prior layout information is obsolete, programs will need to set these properties to False or move the Layout tags accordingly. (2) The second set of objects are Stream subclasses that can be employed when a program needs to easily iterate around the systems and pages defined through the layout objects just described, or to get the exact position on a page (or a graphical representation of a page) for a particular measure or system. (Individual notes coming soon). Normal Score streams can be changed into LayoutStreams by calling `divideByPages(s)` on them. A Score that was organized: Score->Part->Measure would then become: LayoutScore->Page->System->Staff->Measure. The new LayoutScore has methods that enable querying what page or system a measure is in, and specifically where on a page a measure is (or the dimensions of every measure in the piece). However do not call .show() on a LayoutScore -- the normal score it's derived from will work just fine. Nor does calling .show() on a Page or System work yet, but once the LayoutStream has been created, code like this can be done: s = stream.Stream(...) ls = layout.divideByPages(s) pg2sys3 = ls.pages[1].systems[2] # n.b.! 1, 2 measureStart, measureEnd = pg2sys3.measureStart, pg2sys3.measureEnd scoreExcerpt = s.measures(measureStart, measureEnd) scoreExcerpt.show() # will show page 2, system 3 Note that while the coordinates given by music21 for a musicxml score (based on margins, staff size, etc.) generally reflect what is actually in a musicxml producer, unfortunately, x-positions are far less accurately produced by most editors. For instance, Finale scores with measure sizes that have been manually adjusted tend to show their unadjusted measure width and not their actual measure width in the MusicXML. SmartScore Pro tends to produce very good MusicXML layout data. ) annotationsN) namedtuple)base)GatherSpanners) environment) exceptions21)spanner)stream) StaffTypelayout SystemSize)topleftrightbottomPageSize)rrrrwidthheightc"\rSrSrSrSrSrSrg) LayoutBasepz A base class for all Layout objects, defining a classSortOrder and also an inheritance tree. >>> scoreLayout = layout.ScoreLayout() >>> isinstance(scoreLayout, layout.LayoutBase) True icg)Nselfs H/home/james-whalen/.local/lib/python3.13/site-packages/music21/layout.py _reprInternalLayoutBase._reprInternal{srN)__name__ __module__ __qualname____firstlineno____doc__classSortOrderr__static_attributes__rr rrrpsNr rch^\rSrSrSrSSSSSSSS.SU4SjjjrS SjrSrU=r$) ScoreLayouta{ Parameters for configuring a score's layout. PageLayout objects may be found on Measure or Part Streams. >>> pl = layout.PageLayout(pageNumber=4, leftMargin=234, rightMargin=124, ... pageHeight=4000, pageWidth=3000, isNew=True) >>> pl.pageNumber 4 >>> pl.rightMargin 124 >>> pl.leftMargin 234 >>> pl.isNew True This object represents both and elements in musicxml. The appearance tag is handled in the `.style` for the stream (it was here in v7 and before, but did nothing). Note that the appearance and style elements are subject to change during and after the v8 releases. N)scalingMillimeters scalingTenths musicFontwordFont pageLayout systemLayoutstaffLayoutListc >[T U]"S0UD6 XlX lXPlX`l/UlX0lX@lUbXplggNr) super__init__r+r,r/r0r1r-r.) rr+r,r-r.r/r0r1keywords __class__s rr5ScoreLayout.__init__sO $8$"4*+5/;24"    'r cURb URcgURUR- n[X!-S5$)a given the scalingMillimeters and scalingTenths, return the value in millimeters of a number of musicxml "tenths" where a tenth is a tenth of the distance from one staff line to another. returns 0.0 if either of scalingMillimeters or scalingTenths is undefined. >>> sl = layout.ScoreLayout(scalingMillimeters=2.0, scalingTenths=10) >>> sl.tenthsToMillimeters(10) 2.0 Numbers are rounded to a maximum of 6 digits (but because they are floats, there may be inaccuracies. >>> sl.tenthsToMillimeters(17) 3.4 )r+r,round)rtenthsmillimetersPerTenths rtenthsToMillimetersScoreLayout.tenthsToMillimeterssF(  " " *d.@.@.H"558J8JJ(1155r )r-r/r+r,r1r0r.)r+int | float | Noner,rAr- str | Noner.rBr/zPageLayout | Noner0zSystemLayout | Noner1zlist[StaffLayout] | None)r= int | floatreturnrC) r!r"r#r$r%r5r?r' __classcell__r7s@rr)r)sw87;15'+&*/337;?3%33!/3% 3 $ 3 - 3 13#933.66r r)c d^\rSrSrSrSSSSSSSSS.SU4SjjjrSrU=r$) PageLayouta Parameters for configuring a page's layout. PageLayout objects may be found on Measure or Part Streams. >>> pl = layout.PageLayout(pageNumber=4, leftMargin=234, rightMargin=124, ... pageHeight=4000, pageWidth=3000, isNew=True) >>> pl.pageNumber 4 >>> pl.rightMargin 124 >>> pl.leftMargin 234 >>> pl.isNew True This object represents both and elements in musicxml. N) pageNumber leftMargin rightMargin topMargin bottomMargin pageHeight pageWidthisNewc >[T U]"S0U D6 XlX lX0lX@lXPlX`lXplXl gr3) r4r5rJrKrLrMrNrOrPrQ) rrJrKrLrMrNrOrPrQr6r7s rr5PageLayout.__init__sA $8$$$&"($" r )rNrQrKrOrJrPrLrM)rJ int | NonerKrArLrArMrArNrArOrArPrArQ bool | Noner!r"r#r$r%r5r'rErFs@rrHrHsz2)-.2/3-104.2-1$(%,-  +  . ,+"r rHcR^\rSrSrSrSSSSSS.SU4SjjjrSrU=r$) SystemLayoutia| Object that configures or alters a system's layout. SystemLayout objects may be found on Measure or Part Streams. Importantly, if isNew is True then this object indicates that a new system should start here. >>> sl = layout.SystemLayout(leftMargin=234, rightMargin=124, distance=3, isNew=True) >>> sl.distance 3 >>> sl.rightMargin 124 >>> sl.leftMargin 234 >>> sl.isNew True N)rKrLdistance topDistancerQc b>[TU]"S0UD6 XlX lX0lX@lXPlgr3)r4r5rKrLrYrZrQ)rrKrLrYrZrQr6r7s rr5SystemLayout.__init__s4 $8$$&! & r )rYrQrKrLrZ) rKrArLrArYrArZrArQrUrVrFs@rrXrXsS,/3/3,0/3$( +-*  -  " r rXc^\rSrSr%SrSS0rS\S'SSSSS\RS.S U4S jjjr S r S r U=r $) StaffLayouti-a> Object that configures or alters the distance between one staff and another in a system. StaffLayout objects may be found on Measure or Part Streams. The musicxml equivalent lives in the and in attributes. >>> sl = layout.StaffLayout(distance=3, staffNumber=1, staffSize=113, staffLines=5) >>> sl.distance 3 The "number" attribute refers to which staff number in a part group this refers to. Thus, it's not necessary in music21, but we store it if it's there. (defaults to None) >>> sl.staffNumber 1 staffLines specifies the number of lines for a non 5-line staff. >>> sl.staffLines 5 staffSize is a percentage of the base staff size, so this defines a staff 13% larger than normal. Note that it is always converted to a floating point number. >>> sl.staffSize 113.0 >>> sl StaffLayout can also specify the staffType: >>> sl.staffType = stream.enums.StaffType.OSSIA There is one other attribute, '.hidden' which has three settings: * None - inherit from previous StaffLayout object, or False if no object exists * False - not hidden -- show as a default staff * True - hidden -- for playback only staves, or for a hidden/optimized-out staff Note: (TODO: .hidden None is not working; always gives False) staffTypea> What kind of staff is this as a stream.enums.StaffType. >>> sl = layout.StaffLayout() >>> sl.staffType >>> sl.staffType = stream.enums.StaffType.CUE >>> sl.staffType zdict[str, str] _DOC_ATTRN)rY staffNumber staffSize staffLineshiddenr_c >[TU]"S0UD6 XlX lUcSO [ U5UlX@lXPlX`lgr3) r4r5rYrafloatrbrcrdr_) rrYrarbrcrdr_r6r7s rr5StaffLayout.__init__lsD $8$! &-6->TE)DT$ $-r c~SUR<SUR<S3SUR<SUR<3-$)Nz distance z, staffNumber , z staffSize z , staffLines )rYrarbrcrs rrStaffLayout._reprInternalsFDMM,N4;K;K:NbQt~~0 doo=PQR Sr )rYrdrcrarbr_) rYrArarArbrArcrTrdrUr_r ) r!r"r#r$r%r`__annotations__r REGULARr5rr'rErFs@rr^r^-s1f   !I~ -1/3-1(,%)(1(9(9.).-.+ . & . # .&..&SSr r^c\rSrSrSrg)LayoutExceptionirNr!r"r#r$r'rr rrnrnr rnc\rSrSrSrg)StaffGroupExceptionirNrorr rrrrrrpr rrc^\rSrSrSrSSSSS.SU4SjjjrSSjrSSjr\"\\S S 9r SS jr SS jr \"\ \ S S 9r Sr U=r$) StaffGroupia A StaffGroup defines a collection of one or more :class:`~music21.stream.Part` objects, specifying that they should be shown together with a bracket, brace, or other symbol, and may have a common name. >>> p1 = stream.Part() >>> p2 = stream.Part() >>> p1.append(note.Note('C5', type='whole')) >>> p1.append(note.Note('D5', type='whole')) >>> p2.append(note.Note('C3', type='whole')) >>> p2.append(note.Note('D3', type='whole')) >>> p3 = stream.Part() >>> p3.append(note.Note('F#4', type='whole')) >>> p3.append(note.Note('G#4', type='whole')) >>> s = stream.Score() >>> s.insert(0, p1) >>> s.insert(0, p2) >>> s.insert(0, p3) >>> staffGroup1 = layout.StaffGroup([p1, p2], ... name='Marimba', abbreviation='Mba.', symbol='brace') >>> staffGroup1.barTogether = 'Mensurstrich' >>> s.insert(0, staffGroup1) >>> staffGroup2 = layout.StaffGroup([p3], ... name='Xylophone', abbreviation='Xyl.', symbol='bracket') >>> s.insert(0, staffGroup2) >>> #_DOCS_SHOW s.show() .. image:: images/layout_StaffGroup_01.* :width: 400 NT)name barTogether abbreviationsymbolcx>[TU]"U0UD6 U=(d UUlX0lSUlX@lX lgN)r4r5rurw_symbolrx _barTogether)rrurvrwrxspannedElementsr6r7s rr5StaffGroup.__init__s= /6X6(L (MQ  (r cUR$rz)r|rs r_getBarTogetherStaffGroup._getBarTogethers   r cUcgUS;aSUlgUS;aSUlg[U[5(aUR5S:XaSUlg[ SUS35e) N)yesTT)noFF mensurstrich Mensurstrichzthe bar together value  is not acceptable)r| isinstancestrlowerrrrvalues r_setBarTogetherStaffGroup._setBarTogethersb =  m # $D  m # %D  s # # (G .D %(?wFX&YZ Zr a Get or set the barTogether value, with either Boolean values or yes or no strings. Or the string 'Mensurstrich' which indicates barring between staves but not in staves. Currently Mensurstrich is not supported by most exporters. >>> sg = layout.StaffGroup() >>> sg.barTogether = 'yes' >>> sg.barTogether True >>> sg.barTogether = 'Mensurstrich' >>> sg.barTogether 'Mensurstrich' )doccUR$rz)r{rs r _getSymbolStaffGroup._getSymbols ||r cUb[U5R5S:XaSUlgUR5S;a<[R"[R SUR55Ulg[ SUS35e)Nnone)bracelinebracketsquare)rrrrzthe symbol value r)rrr{tcastLiteralrrrs r _setSymbolStaffGroup._setSymbolsm =CJ,,.&8DL [[]D D66!)),P"QSXS^S^S`aDL%(9%@R&ST Tr z Get or set the symbol value, with either Boolean values or yes or no strings. >>> sg = layout.StaffGroup() >>> sg.symbol = 'Brace' >>> sg.symbol 'brace' )r|r{rwrurx)rurBrv,t.Literal[True, False, None, 'Mensurstrich']rwrBrx6t.Literal['bracket', 'line', 'brace', 'square'] | None)rDr)rz9t.Literal[True, False, None, 'Mensurstrich', 'yes', 'no'])rDr)rr)r!r"r#r$r%r5rrpropertyrvrrrxr'rErFs@rrtrtsB#'MQ*.PT ((K( ( ( N ((&! [?OB  K Uj*3  Fr rt LayoutScorec Sn[U5n[U5nUSSnUSSn[5nSUlSUlXhlXxlUH[n [U [R5(aM$SU R;aXl URURU 5U 5 M] Sn Sn Sn UGH upU S- n USLa [SU 5 [5nXlXlXlUSLa UR#X/[$R&S9nOUR#X5nU S-UlUH[n [U R=(a S U ;[R5(aM:URURU 5U 5 M] UR*R-5R/[R05R-5nUHn S U R;dMXlM SnUGHunnUU :dUU:aMU S- n US- nUSLa!UR#UU/[$R&S9nOUR#UU5n[55nU UlU UlUUlUR;U5 UUlUUlUUlSn[?UR*5HnU S- n US- n[A5nUR;U5 U Ul!UUl"U UlUUlUUlURGUU5 [?U[H5nU(dMxUSUl%M U[LnU5S :aU"[?U55Ul(O![OU5S:Xa USUl(OS Ul(URSU5 GM Xl*URW5 URSU5 GM URW5 U$) a, Divides a score into a series of smaller scores according to page breaks. Only searches for PageLayout.isNew or SystemLayout.isNew on the first part. Returns a new `LayoutScore` object. If fastMeasures is True, then the newly created System objects do not have Clef signs, Key Signatures, or necessarily all the applicable spanners in them. On the other hand, the position (on the page) information will be just as correct with fastMeasures = True and it will run much faster on large scores (because our spanner gathering algorithm is currently O(n^2); something TODO: to fix.) >>> lt = corpus.parse('demos/layoutTest.xml') >>> len(lt.parts) 3 >>> len(lt.parts[0].getElementsByClass(stream.Measure)) 80 Divide the score up into layout.Page objects >>> layoutScore = layout.divideByPages(lt, fastMeasures=True) >>> len(layoutScore.pages) 4 >>> lastPage = layoutScore.pages[-1] >>> lastPage.measureStart 64 >>> lastPage.measureEnd 80 the layoutScore is a subclass of stream.Opus: >>> layoutScore >>> 'Opus' in layoutScore.classes True Pages are subclasses of Opus also, since they contain Scores >>> lastPage >>> 'Opus' in lastPage.classes True Each page now has Systems not parts. >>> firstPage = layoutScore.pages[0] >>> len(firstPage.systems) 4 >>> firstSystem = firstPage.systems[0] >>> firstSystem.measureStart 1 >>> firstSystem.measureEnd 5 Systems are a subclass of Score: >>> firstSystem >>> isinstance(firstSystem, stream.Score) True Each System has staves (layout.Staff objects) not parts, though Staff is a subclass of Part >>> secondStaff = firstSystem.staves[1] >>> print(len(secondStaff.getElementsByClass(stream.Measure))) 5 >>> secondStaff >>> isinstance(secondStaff, stream.Part) True c [R"US5nUSSH=nSH4n[X5bM[X#5cM[X[X#55 M6 M? U$)z If there are multiple systemLayouts in an iterable (list or StreamIterator), make a copy of the first one and get information from each successive one into a rich system layout. rN)rYrZrKrL)copydeepcopygetattrsetattr)inner_allSystemLayoutsrichestSystemLayoutsl attributes rgetRichSystemLayout*divideByPages..getRichSystemLayoutIsd #mm,B1,EF(,BU /;C#B2>/GBT*U '%&!+*:1*= '*. '    +i)K$**,33#((*11*+N$,,.AA/R"** 88u    2  # #O 4  ! !/A"5 6#+,s+<=K r c^\rSrSrSrSU4Sjjr\S5rSSjrSr Sr SSjr S r S r SS jrSS jrSS jrSSjrSSjrSSjrSrU=r$)riz Designation that this Score is divided into Pages, Systems, Staves (=Parts), Measures, etc. Used for computing location of notes, etc. If the score does not change between calls to the various getPosition calls, it is much faster as it uses a cache. c R>[TU]"U40UD6 SUlSUlSUlgrz)r4r5rrrr givenElementsr6r7s rr5LayoutScore.__init__s, 3(3 r c,UR[5$rz)rrrs rpagesLayoutScore.pagess&&t,,r c H[RR"U4XS.UD6$)z Borrows stream.Score.show >>> lp = layout.Page() >>> ls = layout.LayoutScore() >>> ls.append(lp) >>> ls.show('text') {0.0} fmtappr Scoreshowrrrr6s rrLayoutScore.show#||  D3D8DDr cSUR;a0URS'URSnX;aX!$SnSn[UR5H)upVXR:dXR:aM%UnUn O Uc [ S5eSnSn[UR 5H)upXR:dXR:aM%U nU n O Uc [ S5eXH4X!'XH4$)a Given a layoutScore from divideByPages and a measureNumber returns a tuple of (pageId, systemId). Note that pageId is probably one less than the page number, assuming that the first page number is 1, the pageId for the first page will be 0. Similarly, the first systemId on each page will be 0 >>> lt = corpus.parse('demos/layoutTest.xml') >>> l = layout.divideByPages(lt, fastMeasures=True) >>> l.getPageAndSystemNumberFromMeasureNumber(80) (3, 3) %pageAndSystemNumberFromMeasureNumbersNz%Cannot find this measure on any page!z^that's strange, this measure was supposed to be on this page, but I couldn't find it anywhere!)_cache enumerater rrrnsystems) rr dataCache foundPage foundPageIdpageIdr foundSystem foundSystemIdsystemIdrs r'getPageAndSystemNumberFromMeasureNumber3LayoutScore.getPageAndSystemNumberFromMeasureNumbers 3$++ ECEDKK? @KK GH  %+ +  )$** 5 F444 H[H[8[ I K  !6  !"IJ J  $-i.?.?$@ H666-J_J_:_$K$M  %A  !#GH H$/#?  ++r cSUR;a0URS'URSnX;aX!$SnSnSnSnSnSnURUn URbURn U RbU Rn U Rb U RnU R b U R nU R b U R nU Rb U RnU Rb U RnU Rb U RnU RbU Rn U Rb U RnU R b U R nU R b U R nU Rb U RnU Rb U RnU Rb U Rn[X4XeXx5n XU'U $)aq return a namedtuple of (top, left, bottom, right, width, height) margins for a given pageId in tenths Default of (100, 100, 100, 100, 850, 1100) if undefined >>> #_DOCS_SHOW g = corpus.parse('luca/gloria') >>> #_DOCS_SHOW m22 = g.parts[0].getElementsByClass(stream.Measure)[22] >>> #_DOCS_SHOW m22.getElementsByClass(layout.PageLayout).first().leftMargin = 204.0 >>> #_DOCS_SHOW gl = layout.divideByPages(g) >>> #_DOCS_SHOW gl.getMarginsAndSizeForPageId(1) >>> layout.PageSize(171.0, 204.0, 171.0, 171.0, 1457.0, 1886.0) #_DOCS_HIDE PageSize(top=171.0, left=204.0, right=171.0, bottom=171.0, width=1457.0, height=1886.0) marginsAndSizeForPageIddiRiL) rr rr/rPrOrMrKrLrNr) rrr pageMarginToppageMarginLeftpageMarginRightpageMarginBottomrPrOrsclr dataTuples rgetMarginsAndSizeForPageId&LayoutScore.getMarginsAndSizeForPageId?s %DKK 757DKK1 2KK 9:  $ $   ::f%    '""C~~)^^<<+ " I==,!#J<<+$&LLM==,%']]N>>-&(nnO??.')$    *$$B||'LL }}(]] ||' " }}(!#~~)"$..*#%?? ]>> lt = corpus.parse('demos/layoutTestMore.xml') >>> ls = layout.divideByPages(lt, fastMeasures = True) >>> ls.getPositionForSystem(0, 0) SystemSize(top=211.0, left=70.0, right=0.0, bottom=696.0) >>> ls.getPositionForSystem(0, 1) SystemSize(top=810.0, left=0.0, right=0.0, bottom=1173.0) >>> ls.getPositionForSystem(0, 2) SystemSize(top=1340.0, left=67.0, right=92.0, bottom=1610.0) >>> ls.getPositionForSystem(0, 3) SystemSize(top=1724.0, left=0.0, right=0.0, bottom=2030.0) >>> ls.getPositionForSystem(0, 4) SystemSize(top=2144.0, left=0.0, right=0.0, bottom=2583.0) positionForSystem-rr)rrr0rKrLrZrYr rgetPositionForSystemrrstavesgetPositionForStaffr rf)rrr!positionForSystemCachecacheKeyrKrLpreviousDistancer+rrlastSystemDimensionsbottomOfLastSystem numStaves lastStaffunused_systemStart systemHeightrrr,s rr3 LayoutScore.getPositionForSystems%. dkk 1/1DKK+ ,!%-@!AXQxj)  -)3 3 Q;8q=       '""C+%%==,!#J>>-"$..Kq=~~1+->>({{.+-;;(ZZ'//9  " " .((B}}(]] ~~) nn 1}>>-')~~$;;*'){{$ a<#'#<#PRWX^R_` +4(r cfSUR;a0URS'URSnUSUSU3nXT;aXE$URXU5nUSLa%URXU5nURXU5nOSnSnUS:aUR XUS- 5upOSn Xz-n X-n X4n XU'U $)a return a tuple of (top, bottom) for a staff, specified by a given pageId, systemId, and staffId in tenths of a staff-space. This distance is specified with respect to the top of the system. Staff scaling ( in musicxml inside an object) is taken into account, but not non-five-line staves. Thus, a normally sized staff is always of height 40 (4 spaces of 10-tenths each) >>> lt = corpus.parse('demos/layoutTest.xml') >>> ls = layout.divideByPages(lt, fastMeasures=True) The first staff (staff 0) of each page/system always begins at height 0 and should end at height 40 if it is a 5-line staff (not taken into account) with no staffSize changes >>> ls.getPositionForStaff(0, 0, 0) (0.0, 40.0) >>> ls.getPositionForStaff(1, 0, 0) (0.0, 40.0) The second staff (staff 1) begins at the end of staff 0 (40.0) + the appropriate staffDistance and adds the height of the staff. Staff 1 here has a size of 80 which means 80% of the normal staff size. 40 * 0.8 = 32.0: >>> ls.getPositionForStaff(0, 0, 1) (133.0, 165.0) The third staff (staff 2) begins after the second staff (staff 1) but is a normal size staff >>> ls.getPositionForStaff(0, 0, 2) (266.0, 306.0) The first staff (staff 0) of the second system (system 1) also begins at 0 and as a normally-sized staff, has height of 40: >>> ls.getPositionForStaff(0, 1, 0) (0.0, 40.0) The spacing between the staves has changed in the second system, but the staff height has not: >>> ls.getPositionForStaff(0, 1, 1) (183.0, 215.0) >>> ls.getPositionForStaff(0, 1, 2) (356.0, 396.0) In the third system (system 2), the staff distance reverts to the distance of system 0, but the staffSize is now 120 or 48 tenths (40 * 1.2 = 48) >>> ls.getPositionForStaff(0, 2, 1) (117.0, 165.0) Page 1 (0), System 4 (3), Staff 2 (1) is a hidden ("optimized") system. Thus, its staffLayout notes this: >>> staffLayout031 = ls.pages[0].systems[3].staves[1].staffLayout >>> staffLayout031 >>> staffLayout031.hidden True Thus, the position for this staff will have the same top and bottom, and the position for the next staff will have the same top as the previous staff: >>> ls.getPositionForStaff(0, 3, 0) (0.0, 40.0) >>> ls.getPositionForStaff(0, 3, 1) (40.0, 40.0) >>> ls.getPositionForStaff(0, 3, 2) (133.0, 173.0) Tests for a score with PartStaff objects: >>> lt = corpus.parse('demos/layoutTestMore.xml') >>> ls = layout.divideByPages(lt, fastMeasures = True) >>> ls.getPositionForStaff(0, 0, 0) (0.0, 40.0) >>> ls.getPositionForStaff(0, 0, 1) (133.0, 173.0) >>> ls.getPositionForStaff(0, 0, 2) (235.0, 275.0) >>> ls.getPositionForStaff(0, 2, 0) (0.0, 40.0) >>> ls.getPositionForStaff(0, 2, 1) (40.0, 40.0) >>> ls.getPositionForStaff(0, 2, 2) (40.0, 40.0) System 4 has the top staff hidden, which has been causing problems: >>> ls.getPositionForStaff(0, 4, 0) (0.0, 0.0) >>> ls.getPositionForStaff(0, 4, 1) (0.0, 40.0) positionForStaffr1Tr:rr)rgetStaffHiddenAttributegetStaffDistanceFromPreviousgetStaffSizeFromLayoutr5)rrr!staffIdpositionForStaffCacher7 hiddenStaffstaffDistanceFromPrevious staffHeightunused_previousStaffToppreviousStaffBottomstaffDistanceFromStart staffBottomr,s rr5LayoutScore.getPositionForStaffsL T[[ 0.0DKK* + $ ,> ?XQxj'3  ,(2 2226WM d "(,(I(I&\c(d %55fPKK(+ % Q;;?;S;S'A+US:XagSUR;a0URS'URSnUSUSU3nXT;aXE$SnUS- nUS:a'URXU5nUSLaSnO US- nUS:aM'USLaSXE'gSn URbCURn U R(a&U RHn U Rn U cMU n O UR UR URUn U R[R5R5nUc3[R"5n[RS US US U35 URS 5nU(aUHn U Rn U cMU n O XU'U $) z return the distance of this staff from the previous staff in the same system for staffId = 0, this is always 0.0 TODO:tests, now that this is out from previous rr:distanceFromPreviousr1FrTgN@No measures found in pageId , systemId , staffId r^)rrBrr1rYr rr4rr rrStream environLocalwarn)rrr!rErFr7foundVisibleStaffi hiddenStatusrHr+slTemp distanceTemp thisStafffirstMeasureOfStaffrs rrC(LayoutScore.getStaffDistanceFromPrevious`s a< ! 424DKK. / $ ,B CXQxj'3  ,(2 2" aK1f77!LLu$$(!E 1f  %.1 ! +%)!    '""C""!11F#)??L#/4@1 2JJv&..x8??H '::6>>JPPR  &"(--/    .vhk(:V]U^_ .@@O )% +0<- * +Dh'((r cSUR;a0URS'URSnUSUSU3nXT;aXE$URURURUnUR [ R 5R5nUc3[ R"5n[RSUSUSU35 SnUS- n U S-n S n U n [UR S 55n U (a%U S nURbXRS - -n S n U S La-URX5unnUcU n OURUUU5n [U 5n XU'U $)aR Get the currently active staff-size for a given pageId, systemId, and staffId. Note that this does not take into account the hidden state of the staff, which, if True, makes the effective size 0.0 -- see getStaffHiddenAttribute >>> lt = corpus.parse('demos/layoutTest.xml') >>> ls = layout.divideByPages(lt, fastMeasures=True) >>> ls.getStaffSizeFromLayout(0, 0, 0) 40.0 >>> ls.getStaffSizeFromLayout(0, 0, 1) 32.0 >>> ls.getStaffSizeFromLayout(0, 0, 2) 40.0 >>> ls.getStaffSizeFromLayout(0, 1, 1) 32.0 >>> ls.getStaffSizeFromLayout(0, 2, 1) 48.0 >>> ls.getStaffSizeFromLayout(0, 3, 1) 32.0 rbr1rQrRrSrg$@Fr^rgY@T)rr rr4rr rrrTrUrVrrbgetSystemBeforeThisrDrf)rrr!rEstaffSizeCacher7r\r] numStaffLines numSpaces staffSizeBasestaffSizeDefinedLocallyrbrstaffLayoutObjpreviousPageIdpreviousSystemIds rrD"LayoutScore.getStaffSizeFromLayouts, dkk )')DKK $[1XQxj'3  %!+ +JJv&..x8??H '::6>>JPPR  &"(--/    .vhk(:V]U^_  !A% !D( "'! 2EEmTU ,Q/N''3)-E-E-MN *.' "e +/3/G/G/Y ,N,%)  77HXZab )$ #,x r cSUR;a0URS'URSnUSUSU3nXT;aXE$URURURUnSn[ UR 5R S55nU(aUSnUb URc,URX5upU cSn OURXU5n O URn XU'U $)a returns the staffLayout.hidden attribute for a staffId, or if it is not defined, recursively search through previous staves until one is found. >>> lt = corpus.parse('demos/layoutTestMore.xml') >>> ls = layout.divideByPages(lt, fastMeasures = True) >>> ls.getStaffHiddenAttribute(0, 0, 0) False >>> ls.getStaffHiddenAttribute(0, 0, 1) False >>> ls.getStaffHiddenAttribute(0, 1, 1) True >>> ls.getStaffHiddenAttribute(0, 2, 1) True >>> ls.getStaffHiddenAttribute(0, 3, 1) False staffHiddenAttributer1Nr^rF) rr rr4rrrrdrarB) rrr!rEstaffHiddenCacher7r\staffLayoutObjectallStaffLayoutObjectsrhri hiddenTags rrB#LayoutScore.getStaffHiddenAttributes& " 424DKK. /;;'=>XQxj'3  '#- -JJv&..x8??H   $Y%6%6%8%K%KM%Z [ 5a 8   $(9(@(@(H/3/G/G/Y ,N%!  88[bc )00I%."r cUS:aXS- 4$US:XagUS- n[URUR5nX4S- 4$)aZ given a pageId and systemId, get the (pageId, systemId) for the previous system. return (None, None) if it's the first system on the first page This test score has five systems on the first page, three on the second, and two on the third >>> lt = corpus.parse('demos/layoutTestMore.xml') >>> ls = layout.divideByPages(lt, fastMeasures = True) >>> systemId = 1 >>> pageId = 2 # last system, last page >>> while pageId is not None: ... pageId, systemId = ls.getSystemBeforeThis(pageId, systemId) ... (pageId, systemId) (2, 0) (1, 2) (1, 1) (1, 0) (0, 4) (0, 3) (0, 2) (0, 1) (0, 0) (None, -1) rr)Nr)rr r)rrr!rh numSystemss rraLayoutScore.getSystemBeforeThissQ. a<a<' '{!#aZNTZZ7??@J!>1 1r cSUR;a0URS'URSnX$;a0XB'XBnX;aXQ$URU5upgURX&U5upURXgU5upUR Xg5n U R n U R nURU5nUR U -U -nUR U-U-nUR U -U -nUR U-U -nURnURnSnUS:Xa UU4UU4U4nOW[U5n[U5n[U5U- n[U5U- n[U5U- n[U5U- nUU4UU4U4nUXQ'U$)a Given a layoutScore from divideByPages, a staffId, and a measureNumber, returns a tuple of ((top, left), (bottom, right), pageId) allowing an exact position for the measure on the page. If returnFormat is "tenths", then it will be returned in tenths. If returnFormat is "float", returns each as a number from 0 to 1 where 0 is the top or left of the page, and 1 is the bottom or right of the page. >>> lt = corpus.parse('demos/layoutTest.xml') >>> ls = layout.divideByPages(lt, fastMeasures = True) The first measure of staff one begins at 336 tenths from the top (125 for the margin top and 211 for the top-staff-distance). It begins 170.0 from the left (100 for the page-margin-left, 70 for staff-margin-left). It ends 40.0 below that (staffHeight) and 247.0 to the right (measure width) >>> ls.getPositionForStaffMeasure(0, 1) ((336.0, 170.0), (376.0, 417.0), 0) The other staves for the same measure are below this one: >>> ls.getPositionForStaffMeasure(1, 1) ((469.0, 170.0), (501.0, 417.0), 0) >>> ls.getPositionForStaffMeasure(2, 1) ((602.0, 170.0), (642.0, 417.0), 0) If float is requested for returning, then the numbers are the fraction of the distance across the page. >>> ls.getPositionForStaffMeasure(0, 1, returnFormat='float') ((0.152..., 0.0996...), (0.170..., 0.244...), 0) Moving over the page boundary: >>> ls.getPositionForStaffMeasure(0, 23) ((1703.0, 1345.0), (1743.0, 1606.0), 0) >>> ls.getPositionForStaffMeasure(1, 23) # hidden ((1743.0, 1345.0), (1743.0, 1606.0), 0) >>> ls.getPositionForStaffMeasure(0, 24) ((195.0, 100.0), (235.0, 431.0), 1) >>> ls.getPositionForStaffMeasure(1, 24) ((328.0, 100.0), (360.0, 431.0), 1) positionForPartMeasureNr=) rr"measurePositionWithinSystemr5r3rrr-rrrf)rrEr returnFormatpositionForPartMeasureCacherrr! startXMeasure endXMeasurestaffToprM systemPos systemTop systemLeftpageSizerrrrrPrOr,topRatio leftRatio bottomRatio rightRatios rgetPositionForStaffMeasure&LayoutScore.getPositionForStaffMeasure/s` $4;; 646DKK0 1&*kk2J&K#  ;9; ' 6/>  % %GG V%)%E%E 8&-" $ 8 87 S--f? MM ^^ 226:llY&1}}z)M9 )K7 *[8NN __  8 #tvuov>Ii(Iz*JSzJ.Hd i/I-*4Ku 1J"I.j0I6RI& r cUbUcURU5up#URURUnSnSnURnUSR [ R 5n[U5HupU Rn U cm[S[U55HTn X|n U R5nUR [ R 5U nURcMHURn O U c&[RSU RS35 Sn O [U 5n U RU:XaU n OX[- nM XUU-4$)a Given a measure number, find the start and end X positions (with respect to the system margins) for the measure. if pageId and systemId are given, then it will speed up the search. But not necessary no staffId is needed since (at least for now) all measures begin and end at the same X position >>> l = corpus.parse('demos/layoutTest.xml') >>> ls = layout.divideByPages(l, fastMeasures = True) >>> ls.measurePositionWithinSystem(1, 0, 0) (0.0, 247.0) >>> ls.measurePositionWithinSystem(2, 0, 0) (247.0, 544.0) >>> ls.measurePositionWithinSystem(3, 0, 0) (544.0, 841.0) Measure positions reset at the start of a new system >>> ls.measurePositionWithinSystem(6) (0.0, 331.0) >>> ls.measurePositionWithinSystem(7) (331.0, 549.0) Nr:rrz Could not get width for measure z, using default of 300gr@)r"r rr4rr rr layoutWidthrangeriterrUrVrrf)rrrr!r startOffsetrthisSystemStaves measureStreamrXm currentWidthjsearchOtherStaffForWidth searchItersearchOtherStaffMeasures rrw'LayoutScore.measurePositionWithinSystemsO6 >X-#KKMZ FZZ'//9  %,,(+>>v~~N m,DA==L#q#&6"78A/?/B,!9!>!>!@J.8.K.KFNN.[\].^+.::F'>'J'J  9#!!6qxxj@VWY$ $\2 xx=($+ --0%///r c [URSRSR5n/n[ UR UR S-5HnUSLa [SU5 /n[ U5HOnURXuU5nUUS- UUSSUSSUSSUSSUSS.n URU 5 MQ URU5 M U$)z returns a list of dictionaries, where each dictionary gives the measure number and other information, etc. in the document. # >>> g = corpus.parse('luca/gloria') # >>> gl = layout.divideByPages(g) # >>> gl.getAllMeasurePositionsInDocument() rrTzDoing measure r)measureNumberActualrrarrrrrJ) rr rr4rrrrrr) rrxrr; allRetInfomNummListstaffNum tupleInfoinfoDicts r getAllMeasurePositionsInDocument,LayoutScore.getAllMeasurePositionsInDocuments 1 --a0778  $++T__q-@ADt#&-E!), ;;HLY +/%)AX#+$Q<?%aLO'l1o&q\!_"+A,  X&-   e $#B$r )rrrrzNN)rintr!rrDr )rrr!rrErrDrf)rrr!rrErrDbool)rrr!rrDztuple[int | None, int])r=)r=F)r!r"r#r$r%r5rr rr"r-r3r5rCrDrBrarrwrr'rErFs@rrrs  -- E/,bENVp@D@)D>@+Z222  2@Wv;0zr cP^\rSrSrSrSU4SjjrSr\S5rS Sjr Sr U=r $) rizQ Designation that all the music in this Stream belongs on a single notated page. c |>[TU]"U40UD6 SUlSUlSUlSUlSUlSUlg)Nr)r4r5rJrrrrr/rs rr5 Page.__init__sA 3(3 r c SUR3$)Nzp.)rJrs rrPage._reprInternalsDOO$%%r c,UR[5$rz)rrrs rr Page.systemss&&v..r c H[RR"U4XS.UD6$)z Borrows stream.Score.show >>> ls = layout.System() >>> lp = layout.Page() >>> lp.append(ls) >>> lp.show('text') {0.0} r rrs rr Page.showrr )rrr/rJrrrzr) r!r"r#r$r%r5rrrrr'rErFs@rrrs2 &// E Er cF^\rSrSrSrSU4SjjrSr\S5rSr U=r $)ri z Designation that all the music in this Stream belongs on a single notated system. Attribute systemNumbering says at what point the numbering of systems resets. It can be either "Score" (default), "Opus", or "Page". c >[TU]"U40UD6 SUlSUlSUlSUlSUlSUlSUlg)Nrr) r4r5rrJrr0systemNumberingrrrs rr5System.__init__sK 3(3 ! & r cRURSURSUR3$)Nz: p.z, sys.)rrJrrs rrSystem._reprInternal!s,##$D(9@U@U?VWWr c,UR[5$rz)rrrs rr4 System.staves$s&&u--r )rrrJrr0rrrz) r!r"r#r$r%r5rrr4r'rErFs@rrr s' X..r rc6^\rSrSrSrSU4SjjrSrSrU=r$)ri)zJ Designation that all the music in this Stream belongs on a single Staff. c >[TU]"U40UD6 SUlSUlSUlSUlSUlSUlSUlSUl g)Nrr) r4r5rarrJr optimizedrinheritedHeightrrs rr5Staff.__init__/sR 3(3 ! ! #r czSRURURURUR5$)Nz{0}: p.{1}, sys.{2}, st.{3})formatrrJrrars rrStaff._reprInternal<s8,33D4I4I48OO484I4I484D4DF Fr )rrrrJrrrrarz) r!r"r#r$r%r5rr'rErFs@rrr)s  FFr rc&\rSrSrSrSrSrSrg)TestiHcnSSKJn SSKJn [R "5n[ SS5HPn[R"5nXElUR5nURU5 URU5 MR [5nSUl SUl UR[R5SRSU5 [5nSUlSUl SUl S UlUR[R5S RSU5 [5nSUlS Ul UR[R5S RSU5 [5nSUlS Ul SUl SUlUR[R5SRSU5 [5nSUlSUl SUl UR[R5SRSU5 UR%5R'U5ng)Nr)note)m21ToXmlr i,T(rr2<r;)music21rmusic21.musicxmlrr rTrrrNoterrXrKrLrrrQrYGeneralObjectExporterparse) rrrsrXrnr unused_raws r testBasicTest.testBasicJs - MMOq"A AH A HHQK HHQK ^  V^^,Q/66q"= ^   V^^,Q/66q"= ^  V^^,Q/66q"= ^   V^^,Q/66q"= ^  V^^,Q/66q"= 335;;A> r c.SSKJn URS5RSnSnUR 5HInSUR ;dMU[ UR5S-[ UR5-S-- nMK URUS5 g) Nrcorpusz luca/gloriarrHz: riz#1: 1, 2: 23, 3: 50, 4: 80, 5: 103, ) rrrrrrrrJr assertEqual)rrcretStrxs rx_testGetPageMeasureNumbers Test.x_testGetPageMeasureNumbers|s}" LL ' - -a 0Aqyy(#all+d2S5IIDPP !FGr cLSSKJn SSKJn URS5nUR USS9nUR SR SRSnUR[U5RS 5[U55 URUR5 g ) z4 we have had problems with attributes disappearing. rr)r zdemos/layoutTest.xmlT)rrzStaff 11: p.1, sys.4, st.2>N) rrr rrr rr4 assertTruereprendswithassertIsNotNoner)rrr ltlsrGs rtestGetStaffLayoutFromStaff Test.testGetStaffLayoutFromStaffs #" \\0 1  ! !"4 ! 8hhqk))!,33A6  [)223PQ[) + [445r rN)r!r"r#r$rrrr'rr rrrHs0?d H 6r r__main__)FF)rz stream.ScorerrrrrDr)r)3r% __future__rrunittest collectionsrtypingrrrmusic21.common.enumsrrrr r music21.stream.enumsr EnvironmentrUr r Music21Objectrr)rHrXr^Music21ExceptionrnSpannerExceptionrrSpannerrtrrrrOpusrrrrrr _DOC_ORDERTestCaserr!mainTestrr rrsKX# "/ *&&x0  &H I j"W X ## "I6*I6Z..h(:(VTS*TSr l33  '22 d d XD DDD DN46 Fz &++z z!E6;;!EJ.V\\.8FFKKF4:|[*40 K68  K6^ z Tr