Mode

class tonalanalysistools.Mode(mode_name='dorian')

Mode.

>>> from abjad.tools import tonalanalysistools

Initializes from string:

>>> tonalanalysistools.Mode('major')
Mode('major')

Initializes from other mode:

>>> mode = tonalanalysistools.Mode('dorian')
>>> tonalanalysistools.Mode(mode)
Mode('dorian')

Lineage

digraph InheritanceGraph { graph [background=transparent, bgcolor=transparent, color=lightslategrey, fontname=Arial, outputorder=edgesfirst, overlap=prism, penwidth=2, rankdir=LR, root="__builtin__.object", splines=spline, style="dotted, rounded", truecolor=true]; node [colorscheme=pastel19, fontname=Arial, fontsize=12, penwidth=2, style="filled, rounded"]; edge [color=lightsteelblue2, penwidth=2]; subgraph cluster_abctools { graph [label=abctools]; "abjad.tools.abctools.AbjadObject.AbjadObject" [color=1, group=0, label=AbjadObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbstractBase" [color=1, group=0, label=AbstractBase, shape=box]; "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" [color=1, group=0, label=AbjadValueObject, shape=box]; "abjad.tools.abctools.AbjadObject.AbjadObject" -> "abjad.tools.abctools.AbjadValueObject.AbjadValueObject"; "abjad.tools.abctools.AbjadObject.AbstractBase" -> "abjad.tools.abctools.AbjadObject.AbjadObject"; } subgraph cluster_tonalanalysistools { graph [label=tonalanalysistools]; "abjad.tools.tonalanalysistools.Mode.Mode" [color=black, fontcolor=white, group=2, label=<<B>Mode</B>>, shape=box, style="filled, rounded"]; } subgraph cluster_builtins { graph [label=builtins]; "builtins.object" [color=2, group=1, label=object, shape=box]; } "abjad.tools.abctools.AbjadValueObject.AbjadValueObject" -> "abjad.tools.tonalanalysistools.Mode.Mode"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

mode_name Gets name.
named_interval_segment Gets named interval segmen
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when argument is a mode with mode name equal to that of this mode.
__format__([format_specification]) Formats Abjad object.
__hash__() Hashes mode.
__len__() Length of mode.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.
__str__() String representation of mode.

Read-only properties

Mode.mode_name

Gets name.

>>> tonalanalysistools.Mode('major').mode_name
'major'
>>> tonalanalysistools.Mode('dorian').mode_name
'dorian'

Returns string.

Mode.named_interval_segment

Gets named interval segmen

>>> mode = tonalanalysistools.Mode('major')
>>> str(mode.named_interval_segment)
'<+M2, +M2, +m2, +M2, +M2, +M2, +m2>'
>>> mode = tonalanalysistools.Mode('dorian')
>>> str(mode.named_interval_segment)
'<+M2, +m2, +M2, +M2, +M2, +m2, +M2>'

Returns named interval segment.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

Mode.__eq__(argument)

Is true when argument is a mode with mode name equal to that of this mode. Otherwise false.

>>> mode_1 = tonalanalysistools.Mode('major')
>>> mode_2 = tonalanalysistools.Mode('major')
>>> mode_3 = tonalanalysistools.Mode('dorian')
>>> mode_1 == mode_1
True
>>> mode_1 == mode_2
True
>>> mode_1 == mode_3
False
>>> mode_2 == mode_1
True
>>> mode_2 == mode_2
True
>>> mode_2 == mode_3
False
>>> mode_3 == mode_1
False
>>> mode_3 == mode_2
False
>>> mode_3 == mode_3
True

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

Set format_specification to ‘’ or ‘storage’. Interprets ‘’ equal to ‘storage’.

Returns string.

Mode.__hash__()

Hashes mode.

Required to be explicitly redefined on Python 3 if __eq__ changes.

Returns integer.

Mode.__len__()

Length of mode.

>>> len(tonalanalysistools.Mode('dorian'))
7

Returns nonnegative integer.

(AbjadObject).__ne__(argument)

Is true when Abjad object does not equal argument. Otherwise false.

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.

Mode.__str__()

String representation of mode.

>>> str(tonalanalysistools.Mode('dorian'))
'dorian'

Returns string.