Chord Class

The muspy.Chord class is a container for chords.

Attributes	Description	Type	Default
time	Start time	int
duration	Chord duration, in time steps	int
pitches	Note pitches as MIDI note numbers	list of int (0-127)	[]
pitches_str	Note pitches as strings	list of str	[]
velocity	Chord velocity	int (0-127)
is_grace	Whether it is a grace chord	bool	False

Hint

muspy.Chord has a property end with setter and getter implemented, which can be handy sometimes.

class muspy.Chord(time, pitches, duration, velocity=None, pitches_str=None, is_grace=False)[source]

A container for chords.

time

Start time of the chord, in time steps.

Type:: int

pitches

Note pitches, as MIDI note numbers. Valid values are 0 to 127.

Type:: list of int

duration

Duration of the chord, in time steps.

Type:: int

velocity

Chord velocity. Valid values are 0 to 127.

Type:: int, default: muspy.DEFAULT_VELOCITY (64)

pitches_str

Note pitches as strings, useful for distinguishing, e.g., C# and Db.

Type:: list of str, optional

is_grace

Is this note a grace note?

Type:: bool, default: False

property start: Start time of the chord.

property end: End time of the chord.

adjust_time(func, attr=None, recursive=True)[source]

Adjust the timing of the chord.

Parameters:

func (callable) – The function used to compute the new timing from the old timing, i.e., new_time = func(old_time).
attr (str, optional) – Attribute to adjust. Defaults to adjust all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Return type:

Object itself.

transpose(semitone)[source]

Transpose the notes by a number of semitones.

Parameters:: semitone (int) – Number of semitones to transpose the notes. A positive value raises the pitches, while a negative value lowers the pitches.
Return type:: Object itself.

clip(lower=0, upper=127)[source]

Clip the velocity of the chord.

Parameters:

lower (int, default: 0) – Lower bound.
upper (int, default: 127) – Upper bound.

Return type:

Object itself.

copy()

Return a shallow copy of the object.

This is equivalent to copy.copy(self)().

Return type:: Shallow copy of the object.

deepcopy()

Return a deep copy of the object.

This is equivalent to copy.deepcopy(self)()

Return type:: Deep copy of the object.

fix_type(attr=None, recursive=True)

Fix the types of attributes.

Parameters:

attr (str, optional) – Attribute to adjust. Defaults to adjust all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Return type:

Object itself.

classmethod from_dict(dict_, strict=False, cast=False)

Return an instance constructed from a dictionary.

Instantiate an object whose attributes and the corresponding values are given as a dictionary.

Parameters:

dict (dict or mapping) – A dictionary that stores the attributes and their values as key-value pairs, e.g., {“attr1”: value1, “attr2”: value2}.
strict (bool, default: False) – Whether to raise errors for invalid input types.
cast (bool, default: False) – Whether to cast types.

Return type:

Constructed object.

is_valid(attr=None, recursive=True)

Return True if an attribute has a valid type and value.

This will recursively apply to an attribute’s attributes.

Parameters:

attr (str, optional) – Attribute to validate. Defaults to validate all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Returns:

Whether the attribute has a valid type and value.

Return type:

bool

See also

muspy.Base.validate(): Raise an error if an attribute has an invalid type or value.
muspy.Base.is_valid_type(): Return True if an attribute is of a valid type.

is_valid_type(attr=None, recursive=True)

Return True if an attribute is of a valid type.

This will apply recursively to an attribute’s attributes.

Parameters:

attr (str, optional) – Attribute to validate. Defaults to validate all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Returns:

Whether the attribute is of a valid type.

Return type:

bool

See also

muspy.Base.validate_type(): Raise an error if a certain attribute is of an invalid type.
muspy.Base.is_valid(): Return True if an attribute has a valid type and value.

pretty_str(skip_missing=True)

Return the attributes as a string in a YAML-like format.

Parameters:: skip_missing (bool, default: True) – Whether to skip attributes with value None or those that are empty lists.
Returns:: Stored data as a string in a YAML-like format.
Return type:: str

See also

muspy.Base.print(): Print the attributes in a YAML-like format.

print(skip_missing=True)

Print the attributes in a YAML-like format.

Parameters:: skip_missing (bool, default: True) – Whether to skip attributes with value None or those that are empty lists.

See also

muspy.Base.pretty_str(): Return the the attributes as a string in a YAML-like format.

to_ordered_dict(skip_missing=True, deepcopy=True)

Return the object as an OrderedDict.

Return an ordered dictionary that stores the attributes and their values as key-value pairs.

Parameters:

skip_missing (bool, default: True) – Whether to skip attributes with value None or those that are empty lists.
deepcopy (bool, default: True) – Whether to make deep copies of the attributes.

Returns:

A dictionary that stores the attributes and their values as key-value pairs, e.g., {“attr1”: value1, “attr2”: value2}.

Return type:

OrderedDict

validate(attr=None, recursive=True)

Raise an error if an attribute has an invalid type or value.

This will apply recursively to an attribute’s attributes.

Parameters:

attr (str, optional) – Attribute to validate. Defaults to validate all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Return type:

Object itself.

See also

muspy.Base.is_valid(): Return True if an attribute has a valid type and value.
muspy.Base.validate_type(): Raise an error if an attribute is of an invalid type.

validate_type(attr=None, recursive=True)

Raise an error if an attribute is of an invalid type.

This will apply recursively to an attribute’s attributes.

Parameters:

attr (str, optional) – Attribute to validate. Defaults to validate all attributes.
recursive (bool, default: True) – Whether to apply recursively.

Return type:

Object itself.

See also

muspy.Base.is_valid_type(): Return True if an attribute is of a valid type.
muspy.Base.validate(): Raise an error if an attribute has an invalid type or value.