== ezOrange and Clarujust User Documentation ==

== ezOrange ==

=== Audiogram Tab ===
The Audiogram tab transforms input data to target gains using 1/3 gain rule across all frequencies.
 * Clicking on the Audiogram adds/moves value at the current frequency. 
 * Double clicking removes any point at that frequency
 * Selecting ShowTarget adds a dotted target line to the HA response curve.

 * Add REUR to IG Targets.  This option adds a generalized REUR to the IG Targets generated by the 1/3 gain rule. This should have everything on the HA response curve graph being in the right gain domain.
 
* Related to this, it is the default settings for the Persistent EQs and Gain. They are a good starting point for the case of a flat 0dB Audiogram. With the "add REUR to IG Targets" option selected (Audiogram tab), an Open fitting (plus REOR, under "Response" radio buttons) will be a reasonable match to the target. This sets up nicely to use the Bump, Tilt and Gain parameters to match the targets for non 0dB audiograms! The Clarujust optimization can then fine tune around these initial settings.

Saving and recalling audiogram data:
 * Export Audiogram. Select File > Save Audiogram, to export it (as a .txt file).
 * Import Audiogram. Select File > Open Audiogram, to import an audiogram (in a .txt file).

The Audiogram file (.txt) must have the following format: Audiogram Type (0 = Standard, 1 = ), Frequency (Hz), Gain Level (dB).  For example:
<code csv>
 0 , 250 , 5 
 0 , 500 , 20 
 0 , 750 , 30 
 0 , 1000 , 55 
 0 , 1500 , 60 
 0 , 2000 , 60 
 0 , 3000 , 65 
 0 , 4000 , 70 
 0 , 6000 , 60 
 0 , 8000 , 45 
 1 , 250 ,-30 
 1 , 500 ,-30 
 1 , 750 ,-30 
 1 , 1000 ,-30 
 1 , 1500 ,-30 
 1 , 2000 ,-30 
 1 , 3000 ,-30 
 1 , 4000 ,-30 
 1 , 6000 ,-30 
 1 , 8000 ,-30 
</code>
 
=== Clarujust Tab ===
On the Clarujust tab, there is a frame labeled Persistent EQs and Gain. The values of these sliders is added to the Overall gain (derived from Bump Tilt, and Gain parameters) when calculating the underlying EQ settings on Ethos. They remain persistent as the B, T and G are changed and are useful as part of the initial fitting exercise. The Gain slider in this section changes the Matrix Gain on the Ethos tab. These parameters are not altered by the optimization algorithm.
 
On the right hand side of the program, there is a check box labeled "add REOR". This feature implements a very simple model that accounts for the sound that arrives in the ear canal of an open fitting device, bypassing the hearing aid.  Ideally, it would only work when the Open fitting radio button is selected, but it does not do so for now.
 
As a protocol issue, it is fine to use bump, tilt, and gain during the initial fitting. The Clarujust module can read the values of those parameters and use them as a starting point for further optimization.

== Roadmap == 
To be added to ezOrange:
  *