Configuration For Classes ========================= Shows default values for classes Designs -------- [Designs][CircleNote] ------------------------- +------------------+---------+-------------------------------+---------------+ | Name | Type | Description | Default Value | +==================+=========+===============================+===============+ | noteFaceColor | str | Color of the note face | 'blue' | +------------------+---------+-------------------------------+---------------+ | noteFill | bool | Whether the note is filled | True | +------------------+---------+-------------------------------+---------------+ | noteEdgeColor | str | Color of the note edge | 'black' | +------------------+---------+-------------------------------+---------------+ | noteEdgeWidth | int | Width of the note edge | 2 | +------------------+---------+-------------------------------+---------------+ | noteRadius | float | Radius of the note | 0.4 | +------------------+---------+-------------------------------+---------------+ | noteOpactiy | float | Opacity of the note | 1 | +------------------+---------+-------------------------------+---------------+ | noteTextColor | str | Color of the note text | 'white' | +------------------+---------+-------------------------------+---------------+ | noteTextFont | str | Font size of the note text | '10pt' | +------------------+---------+-------------------------------+---------------+ | intervals | str or | Intervals associated with | None | | | None | note | | +------------------+---------+-------------------------------+---------------+ | scaleDegrees | str or | Scale degrees of the note | None | | | None | | | +------------------+---------+-------------------------------+---------------+ | name | str or | Name of the note | None | | | None | | | +------------------+---------+-------------------------------+---------------+ | nameWithOctave | str or | Name of the note with octave | None | | | None | | | +------------------+---------+-------------------------------+---------------+ | fret | int or | Fret position | None | | | None | | | +------------------+---------+-------------------------------+---------------+ | string | int or | String position | None | | | None | | | +------------------+---------+-------------------------------+---------------+ [Designs][FretboardFigure] -------------------------------- +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | Name | Type | Description | Default Value | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | fig | figure | The Bokeh figure object. | | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | figHorXRange | Range1d | The x-range for the horizontal orientation. | Range1d(-8*note.getNoteRadius(), (theme.fretboardRange.numOfFrets+1.3)*theme.fretboardDesign.distanceBetweenFrets) | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | figHorYRange | Range1d | The y-range for the horizontal orientation. | Range1d(-3*note.getNoteRadius(), theme.fretboardDesign.distanceBetweenStrings*theme.tuning.numOfStrings) | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | figVerXRange | Range1d | The x-range for the vertical orientation. | Range1d(-3*note.getNoteRadius(), theme.fretboardDesign.distanceBetweenStrings*theme.tuning.numOfStrings) | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | figVerYRange | Range1d | The y-range for the vertical orientation. | Range1d(-8*note.getNoteRadius(), (theme.fretboardRange.numOfFrets+2)*theme.fretboardDesign.distanceBetweenFrets) | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | orientation | str | The orientation of the fretboard figure | 'h' | | | | ('h' for horizontal, 'v' for vertical). | | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | stringLabel | str | The string label layout. | | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | fretLabel | str | The fret label layout. | | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | width | int | The width of the figure. | None | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ | height | int | The height of the figure. | None | +-------------------+----------------------+-------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------+ [Designs][FretboardStyle][FretbooardTheme] -------------------------------------------- +-------------------------------+---------+--------------------------------------------------+-------------------+ | Name | Type | Description | Default | +===============================+=========+==================================================+===================+ | theme | str | The theme to apply to the fretboard design. | ""=light color | | | | Can be blue, dark, wood, and green | | +-------------------------------+---------+--------------------------------------------------+-------------------+ Themes .. image:: ../Images/blueTheme.png :width: 200px :height: 400px .. image:: ../Images/darkTheme.png :width: 200px :height: 400px .. image:: ../Images/defaultTheme.png :width: 200px :height: 400px .. image:: ../Images/greenTheme.png :width: 200px :height: 400px .. image:: ../Images/woodTheme.png :width: 200px :height: 400px +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ | Name | Type | Description | Default | Notes | +==================+===========================+===================================================+======================+=================================================================================================+ | orientation | FretboardOrientation or | The orientation of the fretboard. | 'h' | If a string is provided, it will be converted to FretboardOrientation enum. | | | string | | | | +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ | tuning | Tuning or dict | The tuning of the fretboard. | None | If a dictionary is provided, it will be used to create a Tuning object. | | | | | | Otherwise, it expects an instance of the Tuning class. | +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ | fretboardRange | FretboardRange or dict | The range of frets and strings on the fretboard. | FretboardRange(1, 12,| If a dictionary is provided, it will be used to create a FretboardRange object. | | | | | 6) | Otherwise, it expects an instance of the FretboardRange class. | +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ | fretboardDesign | FretboardDesign or dict | The design settings for the fretboard. | FretboardDesign() | If a dictionary is provided, it will be used to create a FretboardDesign object. | | | | | | Otherwise, it expects an instance of the FretboardDesign class. | +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ [Designs][FretboardStyle][FretboardOrientation] ------------------------------------------------- +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ | Name | Type | Description | Default | Notes | +==================+===========================+===================================================+======================+=================================================================================================+ | orientation |string | The orientation of the fretboard. | 'h' | If a string is provided, it will be converted to FretboardOrientation enum. | | | | | | | +------------------+---------------------------+---------------------------------------------------+----------------------+-------------------------------------------------------------------------------------------------+ [Designs][FretboardStyle][Tuning] --------------------------------- +---------------+---------+-------------------+----------------------+ | Name | Type | Description | Default | +===============+=========+===================+======================+ | letterTuning | list | Letter tuning | STANDARD_TUNING | +---------------+---------+-------------------+----------------------+ | midiTuning | list | MIDI tuning | STANDARD_TUNING_MIDI | +---------------+---------+-------------------+----------------------+ | numOfStrings | int | Number of strings | 6 | +---------------+---------+-------------------+----------------------+ [Designs][FretboardStyle][FretboardRange] ----------------------------------------- +--------------+---------+----------------------------+-----------------+ | Name | Type | Description | Default | +==============+=========+============================+=================+ | fretFrom | int | Starting fret number | 0 | +--------------+---------+----------------------------+-----------------+ | fretTo | int | Ending fret number | 12 | +--------------+---------+----------------------------+-----------------+ | numOfFrets | int | Number of Frets | fretTo-fretFrom | +--------------+---------+----------------------------+-----------------+ | numOfString | int | Number of strings | 6 | +--------------+---------+----------------------------+-----------------+ [Designs][FretboardStyle][FretboardDesign] ------------------------------------------- +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | Name | Type | Description | Default | +==========================+==============+==========================================================================================================================+=================+ | showTuning | bool | Determines whether the tuning of the strings is displayed on the fretboard. | True | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | showFretboardNumber | bool | Determines whether the fretboard number is displayed on the fretboard. | True | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | toolBar | str | Determines whether a toolbar is displayed on the fretboard. Options: 'right', 'above', 'below', 'left'. | "right" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | distanceBetweenFrets | int | The distance between two consecutive frets on the fretboard. | 5 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | distanceBetweenStrings | int | The distance between two consecutive strings on the fretboard. | 2 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretColor | str | The color of the frets on the fretboard. | "black" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretThickness | int | The thickness of the fret lines on the fretboard. | 1 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | stringsColor | str | The color of the strings on the fretboard. | "black" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | stringThickness | float | The thickness of the string lines on the fretboard. | 1.5 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretOpacity | float | The opacity of the frets on the fretboard. | 0.3 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | stringsOpacity | float | The opacity of the strings on the fretboard. | 1.0 | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | backgroundColor | str | The background color of the fretboard. | "white" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretboardMarkerColor | str | The color of the fretboard markers. | "#DCDCDC" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | noteType | str | The type of notes to be displayed on the fretboard. Options: 'prediction', 'groundTruth', 'white', 'black', 'darkBlue', | "prediction" | | | | 'green'. | | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | tuningLabelColor | str | The color of the tuning labels on the fretboard. | "black" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | tuningLabelFontSize | str | The font size of the tuning labels on the fretboard. | "10pt" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretLabelColor | str | The color of the fret labels on the fretboard. | "black" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ | fretLabelFontSize | str | The font size of the fret labels on the fretboard. | "10pt" | +--------------------------+--------------+--------------------------------------------------------------------------------------------------------------------------+-----------------+ Videos -------- [Videos][Audio] ---------------------- +---------------+--------------+----------------------------------------------------+-----------------+ | Name | Type | Description | Default | +===============+==============+====================================================+=================+ | audioPath | str | The path to the audio file. | N/A | +---------------+--------------+----------------------------------------------------+-----------------+ | sampleRate | int | The sample rate of the audio. | 44100 | +---------------+--------------+----------------------------------------------------+-----------------+ [Videos][Images] ---------------------- +-------------------+--------------+---------------------------------------------------------+-------------------------+ | Name | Type | Description | Default | +===================+==============+=========================================================+=========================+ | outputPathName | str | The path to the directory where images will be saved. | os.path.join(BASE_PATH, | | | | | 'Outputs', 'Images') | +-------------------+--------------+---------------------------------------------------------+-------------------------+ | name | str | The name of the image file (without extension). | "default" | +-------------------+--------------+---------------------------------------------------------+-------------------------+ | meta | str | The file extension or metadata of the image file. | ".png" | +-------------------+--------------+---------------------------------------------------------+-------------------------+ | fileName | str | The complete path of the image file, including directory| os.path.join(self. | | | | and file name. | outputPathName, self. | | | | | name + meta) | +-------------------+--------------+---------------------------------------------------------+-------------------------+ [Videos][TabSequence] ---------------------- +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ | Name | Type | Description | Default | +=================+=================+==========================================================================================================+=====================+ | trackNum | int | The index of the track to load from the dataset. | 0 | +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ | frameRate | float | The frame rate of the tab sequence. Default is FRAMERATE. | FRAMERATE | +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ | filePath | str | The file path to the GuitarSet dataset. Default is 'BASE_PATH/GuitarSet'. | BASE_PATH/GuitarSet | +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ | frameType | str | The type of the tab frames. Either "fret" or "midi" | "fret" | +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ [Videos][Video] --------------- +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | Name | Type | Description | Default | +===========================+=====================+=======================================================================================================+=================================================+ | frameRate | float | The frame rate of the video. Default is FRAMERATE. | FRAMERATE | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoName | str | The name of the video. | "defaultVid" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | fileExtension | str | The file extension of the video. | ".mp4" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | codec | str | The video codec. | "mp4v" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoWAudioName | str | The name of the video with audio. | "defaultVideoWAudio" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | frames | dict | A dictionary of frames with their corresponding time frames. | N/A | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | currentAddTabFrames| int | The number of frames added through the `addTab` method. | 0 | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoPath | str | The path to the video directory. | "BASE_PATH/Outputs/Videos" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoPathWithName | str | The path to the video file. | "videoPath/videoName" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | audioPath | str | The path to the audio directory. | "BASE_PATH/GuitarSet" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | audioName | str | The name of the audio file. | "" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | audioPathWithName | str | The path to the audio file. | "audioPath/audioName" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoWAudioPath | str | The path to the video with audio directory. | "BASE_PATH/Outputs/Videos" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ | videoWAudioPathWithName | str | The path to the video with audio file. | "videoWAudioPath/videoWAudioName+fileExtension" | +---------------------------+---------------------+-------------------------------------------------------------------------------------------------------+-------------------------------------------------+ [Videos][VideoManager] ---------------------- +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ | Name | Type | Description | Default | +=================+=================+==========================================================================================================+=====================+ | imageProgressBar| bool | Flag indicating whether to display a progress bar while generating images. | True | +-----------------+-----------------+----------------------------------------------------------------------------------------------------------+---------------------+ Utilities ----------- [Utilities][Constants] ---------------------- .. literalinclude:: ../seeFretboard/Utilities/Constants.py :language: python Configuration For Theory Related ================================= Intervals --------- - P1 - m2 - M2 - m3 - M3 - P4 - TT - P5 - m6 - M6 - m7 - M7 - P8 Arpeggios Types ---------------- - 'major' - 'minor' - 'augmented' - 'diminished' - 'dominant-seventh' - 'major-seventh' - 'minor-major-seventh' - 'minor-seventh' - 'augmented-major-seventh' - 'augmented-seventh' - 'half-diminished-seventh' - 'diminished-seventh' - 'seventh-flat-five' - 'major-sixth' - 'minor-sixth' - 'major-ninth' - 'dominant-ninth' - 'minor-major-ninth' - 'minor-ninth' - 'augmented-major-ninth' - 'augmented-dominant-ninth' - 'half-diminished-ninth' - 'half-diminished-minor-ninth' - 'diminished-ninth' - 'diminished-minor-ninth' - 'dominant-11th' - 'major-11th' - 'minor-major-11th' - 'minor-11th' - 'augmented-major-11th' - 'augmented-11th' - 'half-diminished-11th' - 'diminished-11th' - 'major-13th' - 'dominant-13th' - 'minor-major-13th' - 'minor-13th' - 'augmented-major-13th' - 'augmented-dominant-13th' - 'half-diminished-13th' - 'suspended-second' - 'suspended-fourth' - 'suspended-fourth-seventh' - 'Neapolitan' - 'Italian' - 'French' - 'German' - 'pedal' - 'power' - 'Tristan' - for custom, input chordPitches Scales Types ------------- - Major/Ionian - Minor/Aeolian - Harmonic Minor - Melodic Minor - Dorian - Phrygian - Lydian - Mixolydian - Locrian - Blues - Whole Tone - Chromatic - Hypodorian - Hypophrygian - Hypolydian - Hypomixolydian - Hypoaeolian - Octatonic - Octave Repeating - Cyclical - RagAsawari - RagMarwa - Weighted Hexatonic Blues - Minor Pentatonic - Major Pentatonic - for custom, input intervalsDegrees CAGED Chords Types ------------------ - C, A, E, D Position - maj,maj7,dom7,min,min7,min7b5,dim,dim7,aug - G Position - maj,min,dim,aug DROP Chords ------------------ - Drop2 and Drop3 - 1, 2, 3, 4 Positions - maj7,dom7,min7,min7b5,dim7 customShapes Classes -------------------- Create your own shape or chords The index of each list corresponds to each other, meaning the elements at the same index in each list represent the attributes of the same note, position, or scale degree. shapeName1: { note: [list of notes], position: [list of positions], scaleDegree: [list of scale degrees] }, shapeName2: { note: [list of notes], position: [list of positions], scaleDegree: [list of scale degrees] },