NumberedPitchClassColorMap

class pitchtools.NumberedPitchClassColorMap(pitch_iterables=None, colors=None)

Numbered pitch-class color map.

Maps pitch-classes to red, green and blue:

>>> pitches = [
...     [-8, 2, 10, 21],
...     [0, 11, 32, 41],
...     [15, 25, 42, 43],
...     ]
>>> colors = ['red', 'green', 'blue']
>>> color_map = pitchtools.NumberedPitchClassColorMap(pitches, colors)

Numbered pitch-class color maps are immutable.

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_pitchtools { graph [label=pitchtools]; "abjad.tools.pitchtools.NumberedPitchClassColorMap.NumberedPitchClassColorMap" [color=black, fontcolor=white, group=2, label=<<B>NumberedPitchClassColorMap</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.pitchtools.NumberedPitchClassColorMap.NumberedPitchClassColorMap"; "builtins.object" -> "abjad.tools.abctools.AbjadObject.AbstractBase"; }

Bases

Attribute summary

colors Colors of color map.
get(key[, alternative]) Gets key from color map.
is_twelve_tone_complete Is true when color map contains all 12-ET pitch-classes.
is_twenty_four_tone_complete Is true when color map contains all 24-ET pitch-classes.
pairs Pairs of color map.
pitch_iterables Pitch interables of color map.
__copy__(*arguments) Copies Abjad value object.
__eq__(argument) Is true when all initialization values of Abjad value object equal the initialization values of argument.
__format__([format_specification]) Formats Abjad object.
__getitem__(pitch_class) Gets pitch_class color.
__hash__() Hashes Abjad value object.
__ne__(argument) Is true when Abjad object does not equal argument.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

NumberedPitchClassColorMap.colors

Colors of color map.

>>> color_map.colors
['red', 'green', 'blue']

Returns list.

NumberedPitchClassColorMap.is_twelve_tone_complete

Is true when color map contains all 12-ET pitch-classes.

>>> color_map.is_twelve_tone_complete
True

Return boolean.

NumberedPitchClassColorMap.is_twenty_four_tone_complete

Is true when color map contains all 24-ET pitch-classes.

>>> color_map.is_twenty_four_tone_complete
False

Return boolean.

NumberedPitchClassColorMap.pairs

Pairs of color map.

>>> for pair in color_map.pairs:
...     pair
(0, 'green')
(1, 'blue')
(2, 'red')
(3, 'blue')
(4, 'red')
(5, 'green')
(6, 'blue')
(7, 'blue')
(8, 'green')
(9, 'red')
(10, 'red')
(11, 'green')

Returns list.

NumberedPitchClassColorMap.pitch_iterables

Pitch interables of color map.

>>> color_map.pitch_iterables
[[-8, 2, 10, 21], [0, 11, 32, 41], [15, 25, 42, 43]]

Returns ?

Methods

NumberedPitchClassColorMap.get(key, alternative=None)

Gets key from color map.

>>> color_map.get(11)
'green'

Returns alternative when key is not found.

Returns string.

Special methods

(AbjadValueObject).__copy__(*arguments)

Copies Abjad value object.

Returns new Abjad value object.

(AbjadValueObject).__eq__(argument)

Is true when all initialization values of Abjad value object equal the initialization values of argument.

Returns true or false.

(AbjadObject).__format__(format_specification='')

Formats Abjad object.

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

Returns string.

NumberedPitchClassColorMap.__getitem__(pitch_class)

Gets pitch_class color.

>>> color_map[11]
'green'

Returns string.

(AbjadValueObject).__hash__()

Hashes Abjad value object.

Returns 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.