RegistrationComponent

class pitchtools.RegistrationComponent(source_pitch_range='[A0, C8]', target_octave_start_pitch=0)

Registration component.

Example. Initializes a registration component that specifies that all pitches from A0 up to and including C8 should be tranposed to the octave starting at Eb5 (numbered pitch 15):

>>> component = pitchtools.RegistrationComponent('[A0, C8]', 15)
>>> component
RegistrationComponent(source_pitch_range=PitchRange(range_string='[A0, C8]'), target_octave_start_pitch=NumberedPitch(15))

Models pitchtools.transpose_pitch_number_by_octave_transposition_mapping input part. (See the docs for that function.)

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

Bases

Attribute summary

source_pitch_range Gets source pitch range of registration component.
target_octave_start_pitch Gets target octave start pitch of registration component.
__copy__(\*args) Copies Abjad value object.
__eq__(expr) Is true when expr is a registration component with source pitch range and target octave start pitch equal to those of this registration component.
__format__([format_specification]) Formats registration component.
__hash__() Hashes registration component.
__ne__(expr) Is true when Abjad object does not equal expr.
__repr__() Gets interpreter representation of Abjad object.

Read-only properties

RegistrationComponent.source_pitch_range

Gets source pitch range of registration component.

Gets source pitch range of example component:

>>> component.source_pitch_range
PitchRange(range_string='[A0, C8]')

Returns pitch range or none.

RegistrationComponent.target_octave_start_pitch

Gets target octave start pitch of registration component.

Gets target octave start pitch of example component:

>>> component.target_octave_start_pitch
NumberedPitch(15)

Returns numbered pitch or none.

Special methods

(AbjadValueObject).__copy__(*args)

Copies Abjad value object.

Returns new Abjad value object.

RegistrationComponent.__eq__(expr)

Is true when expr is a registration component with source pitch range and target octave start pitch equal to those of this registration component. Otherwise false.

Returns true or false.

RegistrationComponent.__format__(format_specification='')

Formats registration component.

Set format_specification to ‘’, ‘lilypond’ or ‘storage’.

Returns string.

RegistrationComponent.__hash__()

Hashes registration component.

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

Returns integer.

(AbjadObject).__ne__(expr)

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

Returns true or false.

(AbjadObject).__repr__()

Gets interpreter representation of Abjad object.

Returns string.