Skip to content

Fix LaTeX octave diacritics visual inconsistency #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jon-myers merged 1 commit into from
Sep 8, 2025
Merged

Fix LaTeX octave diacritics visual inconsistency #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions idtap/classes/pitch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,12 +294,12 @@ def _octave_diacritic(self) -> str:
def _octave_latex_diacritic(self) -> str:
"""Convert octave to LaTeX math notation for proper diacritic positioning."""
mapping = {
-3: r'\underset{\bullet\bullet\bullet}', # Triple dot below
-2: r'\underset{\bullet\bullet}', # Double dot below
-1: r'\underset{\bullet}', # Single dot below
1: r'\dot', # Single dot above
2: r'\ddot', # Double dot above
3: r'\dddot' # Triple dot above
-3: r'\underset{\cdot\cdot\cdot}', # Triple dot below
-2: r'\underset{\cdot\cdot}', # Double dot below
-1: r'\underset{\cdot}', # Single dot below
1: r'\dot', # Single dot above
2: r'\ddot', # Double dot above
3: r'\dddot' # Triple dot above
}
return mapping.get(self.oct, '')

Expand Down
26 changes: 13 additions & 13 deletions idtap/tests/pitch_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,33 +617,33 @@ def test_latex_octaved_sargam_letter_negative_octaves():
"""Test LaTeX octaved sargam letter with negative octaves (dots below)."""
# Test oct=-1 (single dot below)
p = Pitch({'swara': 'sa', 'oct': -1})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet}{\mathrm{S}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot}{\mathrm{S}}$'

p = Pitch({'swara': 're', 'raised': True, 'oct': -1})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet}{\mathrm{R}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot}{\mathrm{R}}$'

# Test oct=-2 (double dot below)
p = Pitch({'swara': 'ga', 'raised': False, 'oct': -2})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet\bullet}{\mathrm{g}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot\cdot}{\mathrm{g}}$'

p = Pitch({'swara': 'ma', 'raised': True, 'oct': -2})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet\bullet}{\mathrm{M}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot\cdot}{\mathrm{M}}$'

# Test oct=-3 (triple dot below)
p = Pitch({'swara': 'pa', 'oct': -3})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet\bullet\bullet}{\mathrm{P}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot\cdot\cdot}{\mathrm{P}}$'

p = Pitch({'swara': 'dha', 'raised': False, 'oct': -3})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet\bullet\bullet}{\mathrm{d}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot\cdot\cdot}{\mathrm{d}}$'


def test_latex_octaved_sargam_letter_all_sargam_all_octaves():
"""Test all sargam letters across all octave levels."""
sargam_letters = ['sa', 're', 'ga', 'ma', 'pa', 'dha', 'ni']
octave_expected = {
-3: r'\underset{\bullet\bullet\bullet}',
-2: r'\underset{\bullet\bullet}',
-1: r'\underset{\bullet}',
-3: r'\underset{\cdot\cdot\cdot}',
-2: r'\underset{\cdot\cdot}',
-1: r'\underset{\cdot}',
0: '',
1: r'\dot',
2: r'\ddot',
Expand Down Expand Up @@ -707,9 +707,9 @@ def test_latex_octave_diacritic_helper():
"""Test the _octave_latex_diacritic helper method."""
# Test all octave levels
octave_mapping = {
-3: r'\underset{\bullet\bullet\bullet}',
-2: r'\underset{\bullet\bullet}',
-1: r'\underset{\bullet}',
-3: r'\underset{\cdot\cdot\cdot}',
-2: r'\underset{\cdot\cdot}',
-1: r'\underset{\cdot}',
0: '',
1: r'\dot',
2: r'\ddot',
Expand All @@ -729,7 +729,7 @@ def test_latex_properties_edge_cases():

# Test with different fundamentals (should not affect LaTeX output)
p = Pitch({'swara': 'ma', 'raised': True, 'oct': -1, 'fundamental': 440.0})
assert p.latex_octaved_sargam_letter == r'$\underset{\bullet}{\mathrm{M}}$'
assert p.latex_octaved_sargam_letter == r'$\underset{\cdot}{\mathrm{M}}$'

# Test serialization includes existing functionality
p = Pitch({'swara': 'dha', 'raised': False, 'oct': 2})
Expand Down
Loading