music21.clef¶
This module defines numerous subclasses of
Clef
, providing object representations for all
commonly used clefs. Clef objects are often found
within Measure
objects.
Functions¶
-
music21.clef.
clefFromString
(clefString, octaveShift=0)¶ Returns a Clef object given a string like “G2” or “F4” etc.
Does not refer to a violin/guitar string.
>>> tc = clef.clefFromString("G2") >>> tc <music21.clef.TrebleClef> >>> nonStandard1 = clef.clefFromString("F1") >>> nonStandard1 <music21.clef.FClef> >>> nonStandard1.line 1 >>> nonStandard2 = clef.clefFromString("D4") >>> nonStandard2 <music21.clef.PitchClef> >>> nonStandard2.sign 'D' >>> nonStandard2.line 4
>>> tc8vb = clef.clefFromString("G2", -1) >>> tc8vb <music21.clef.Treble8vbClef>
Three special clefs, Tab, Percussion, and None are also supported.
>>> tabClef = clef.clefFromString("TAB") >>> tabClef <music21.clef.TabClef>
Case does not matter.
>>> tc8vb = clef.clefFromString("g2", -1) >>> tc8vb <music21.clef.Treble8vbClef>
>>> percussionClef = clef.clefFromString('Percussion') >>> percussionClef <music21.clef.PercussionClef>
>>> noClef = clef.clefFromString('None') >>> noClef <music21.clef.NoClef>
Clef¶
-
class
music21.clef.
Clef
¶ A Clef is a basic music21 object for representing musical clefs (Treble, Bass, etc.)
Some clefs only represent the graphical element of the clef, such as G clef, which is subclassed by TrebleClef() and FrenchViolinClef().
>>> tc = clef.TrebleClef() >>> tc <music21.clef.TrebleClef> >>> tc.sign 'G' >>> tc.line 2
Most clefs also have a “lowest note” function which represents the
diatonicNoteNum
of the note. (Where C4,C#4,C##4,C-4 etc. = 29, all types of D4 = 30, etc.)>>> tc.lowestLine 31
Clef
bases
Clef
read-only properties
Read-only properties inherited from Music21Object
:
Clef
read/write properties
Read/write properties inherited from Music21Object
:
Clef
methods
Methods inherited from Music21Object
:
Clef
instance variables
Instance variables inherited from Music21Object
:
TrebleClef¶
-
class
music21.clef.
TrebleClef
¶
TrebleClef
bases
TrebleClef
read-only properties
Read-only properties inherited from Music21Object
:
TrebleClef
read/write properties
Read/write properties inherited from Music21Object
:
TrebleClef
methods
Methods inherited from Music21Object
:
TrebleClef
instance variables
Instance variables inherited from Music21Object
:
BassClef¶
-
class
music21.clef.
BassClef
¶
BassClef
bases
BassClef
read-only properties
Read-only properties inherited from Music21Object
:
BassClef
read/write properties
Read/write properties inherited from Music21Object
:
BassClef
methods
Methods inherited from Music21Object
:
BassClef
instance variables
Instance variables inherited from Music21Object
:
AltoClef¶
-
class
music21.clef.
AltoClef
¶
AltoClef
bases
AltoClef
read-only properties
Read-only properties inherited from Music21Object
:
AltoClef
read/write properties
Read/write properties inherited from Music21Object
:
AltoClef
methods
Methods inherited from Music21Object
:
AltoClef
instance variables
Instance variables inherited from Music21Object
:
Bass8vaClef¶
-
class
music21.clef.
Bass8vaClef
¶
Bass8vaClef
bases
Bass8vaClef
read-only properties
Read-only properties inherited from Music21Object
:
Bass8vaClef
read/write properties
Read/write properties inherited from Music21Object
:
Bass8vaClef
methods
Methods inherited from Music21Object
:
Bass8vaClef
instance variables
Instance variables inherited from Music21Object
:
Bass8vbClef¶
-
class
music21.clef.
Bass8vbClef
¶
Bass8vbClef
bases
Bass8vbClef
read-only properties
Read-only properties inherited from Music21Object
:
Bass8vbClef
read/write properties
Read/write properties inherited from Music21Object
:
Bass8vbClef
methods
Methods inherited from Music21Object
:
Bass8vbClef
instance variables
Instance variables inherited from Music21Object
:
CBaritoneClef¶
-
class
music21.clef.
CBaritoneClef
¶
CBaritoneClef
bases
CBaritoneClef
read-only properties
Read-only properties inherited from Music21Object
:
CBaritoneClef
read/write properties
Read/write properties inherited from Music21Object
:
CBaritoneClef
methods
Methods inherited from Music21Object
:
CBaritoneClef
instance variables
Instance variables inherited from Music21Object
:
CClef¶
-
class
music21.clef.
CClef
¶
CClef
bases
CClef
read-only properties
Read-only properties inherited from Music21Object
:
CClef
read/write properties
Read/write properties inherited from Music21Object
:
CClef
methods
Methods inherited from Music21Object
:
CClef
instance variables
Instance variables inherited from Music21Object
:
FBaritoneClef¶
-
class
music21.clef.
FBaritoneClef
¶
FBaritoneClef
bases
FBaritoneClef
read-only properties
Read-only properties inherited from Music21Object
:
FBaritoneClef
read/write properties
Read/write properties inherited from Music21Object
:
FBaritoneClef
methods
Methods inherited from Music21Object
:
FBaritoneClef
instance variables
Instance variables inherited from Music21Object
:
FClef¶
-
class
music21.clef.
FClef
¶
FClef
bases
FClef
read-only properties
Read-only properties inherited from Music21Object
:
FClef
read/write properties
Read/write properties inherited from Music21Object
:
FClef
methods
Methods inherited from Music21Object
:
FClef
instance variables
Instance variables inherited from Music21Object
:
FrenchViolinClef¶
-
class
music21.clef.
FrenchViolinClef
¶
FrenchViolinClef
bases
FrenchViolinClef
read-only properties
Read-only properties inherited from Music21Object
:
FrenchViolinClef
read/write properties
Read/write properties inherited from Music21Object
:
FrenchViolinClef
methods
Methods inherited from Music21Object
:
FrenchViolinClef
instance variables
Instance variables inherited from Music21Object
:
GClef¶
-
class
music21.clef.
GClef
¶
GClef
bases
GClef
read-only properties
Read-only properties inherited from Music21Object
:
GClef
read/write properties
Read/write properties inherited from Music21Object
:
GClef
methods
Methods inherited from Music21Object
:
GClef
instance variables
Instance variables inherited from Music21Object
:
GSopranoClef¶
-
class
music21.clef.
GSopranoClef
¶
GSopranoClef
bases
GSopranoClef
read-only properties
Read-only properties inherited from Music21Object
:
GSopranoClef
read/write properties
Read/write properties inherited from Music21Object
:
GSopranoClef
methods
Methods inherited from Music21Object
:
GSopranoClef
instance variables
Instance variables inherited from Music21Object
:
JianpuClef¶
-
class
music21.clef.
JianpuClef
¶ Jianpu notation does not use a clef, but musicxml marks it with a specialized “jianpu” sign.
>>> jc = clef.JianpuClef() >>> jc.sign 'jianpu'
JianpuClef
bases
JianpuClef
read-only properties
Read-only properties inherited from Music21Object
:
JianpuClef
read/write properties
Read/write properties inherited from Music21Object
:
JianpuClef
methods
Methods inherited from Music21Object
:
JianpuClef
instance variables
Instance variables inherited from Music21Object
:
MezzoSopranoClef¶
-
class
music21.clef.
MezzoSopranoClef
¶
MezzoSopranoClef
bases
MezzoSopranoClef
read-only properties
Read-only properties inherited from Music21Object
:
MezzoSopranoClef
read/write properties
Read/write properties inherited from Music21Object
:
MezzoSopranoClef
methods
Methods inherited from Music21Object
:
MezzoSopranoClef
instance variables
Instance variables inherited from Music21Object
:
NoClef¶
-
class
music21.clef.
NoClef
¶ represents the absence of a Clef.
>>> nc = clef.NoClef() >>> nc.sign 'none'
Note that the sign is the string ‘none’ not the None object
>>> nc.sign is None False
NoClef
bases
NoClef
read-only properties
Read-only properties inherited from Music21Object
:
NoClef
read/write properties
Read/write properties inherited from Music21Object
:
NoClef
methods
Methods inherited from Music21Object
:
NoClef
instance variables
Instance variables inherited from Music21Object
:
PercussionClef¶
-
class
music21.clef.
PercussionClef
¶ represents a Percussion clef.
>>> pc = clef.PercussionClef() >>> pc.sign 'percussion' >>> pc.line is None True
PercussionClef
bases
PercussionClef
read-only properties
Read-only properties inherited from Music21Object
:
PercussionClef
read/write properties
Read/write properties inherited from Music21Object
:
PercussionClef
methods
Methods inherited from Music21Object
:
PercussionClef
instance variables
Instance variables inherited from Music21Object
:
PitchClef¶
-
class
music21.clef.
PitchClef
¶ superclass for all other clef subclasses.
PitchClef
bases
PitchClef
read-only properties
Read-only properties inherited from Music21Object
:
PitchClef
read/write properties
Read/write properties inherited from Music21Object
:
PitchClef
methods
Methods inherited from Music21Object
:
PitchClef
instance variables
Instance variables inherited from Music21Object
:
SopranoClef¶
-
class
music21.clef.
SopranoClef
¶
SopranoClef
bases
SopranoClef
read-only properties
Read-only properties inherited from Music21Object
:
SopranoClef
read/write properties
Read/write properties inherited from Music21Object
:
SopranoClef
methods
Methods inherited from Music21Object
:
SopranoClef
instance variables
Instance variables inherited from Music21Object
:
SubBassClef¶
-
class
music21.clef.
SubBassClef
¶
SubBassClef
bases
SubBassClef
read-only properties
Read-only properties inherited from Music21Object
:
SubBassClef
read/write properties
Read/write properties inherited from Music21Object
:
SubBassClef
methods
Methods inherited from Music21Object
:
SubBassClef
instance variables
Instance variables inherited from Music21Object
:
TabClef¶
-
class
music21.clef.
TabClef
¶ represents a Tablature clef.
>>> a = clef.TabClef() >>> a.sign 'TAB'
TabClef
bases
TabClef
read-only properties
Read-only properties inherited from Music21Object
:
TabClef
read/write properties
Read/write properties inherited from Music21Object
:
TabClef
methods
Methods inherited from Music21Object
:
TabClef
instance variables
Instance variables inherited from Music21Object
:
TenorClef¶
-
class
music21.clef.
TenorClef
¶
TenorClef
bases
TenorClef
read-only properties
Read-only properties inherited from Music21Object
:
TenorClef
read/write properties
Read/write properties inherited from Music21Object
:
TenorClef
methods
Methods inherited from Music21Object
:
TenorClef
instance variables
Instance variables inherited from Music21Object
:
Treble8vaClef¶
-
class
music21.clef.
Treble8vaClef
¶
Treble8vaClef
bases
Treble8vaClef
read-only properties
Read-only properties inherited from Music21Object
:
Treble8vaClef
read/write properties
Read/write properties inherited from Music21Object
:
Treble8vaClef
methods
Methods inherited from Music21Object
:
Treble8vaClef
instance variables
Instance variables inherited from Music21Object
:
Treble8vbClef¶
-
class
music21.clef.
Treble8vbClef
¶
Treble8vbClef
bases
Treble8vbClef
read-only properties
Read-only properties inherited from Music21Object
:
Treble8vbClef
read/write properties
Read/write properties inherited from Music21Object
:
Treble8vbClef
methods
Methods inherited from Music21Object
:
Treble8vbClef
instance variables
Instance variables inherited from Music21Object
: