Skip to content

Commit

Permalink
topcat: document new aux/density Scaling function option
Browse files Browse the repository at this point in the history
Add screenshots and change log notes in the topcat and stilts user
documents about the new capabilities for applying scaling functions
to Aux axis and Density shading mode colour maps, and
spectrogram layer.
  • Loading branch information
mbtaylor committed Jan 28, 2015
1 parent 97ad679 commit 9f61949
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 24 deletions.
Binary file modified topcat/src/docs/figures/ShaderControl_map.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified topcat/src/docs/figures/SpectrogramLayerControl_style.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified topcat/src/docs/figures/mode_density.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 53 additions & 24 deletions topcat/src/docs/sun253.xml
Expand Up @@ -7574,24 +7574,28 @@ are coloured by data value to represent an additional dimension in the data.
<p>The <label>Map</label> tab controls the aux axis colour map.
It has the following options:
<dl>
<dt>Shader</dt>
<dt>Aux Shader</dt>
<dd><p>Select the colour map from a list of options.
</p></dd>
<dt>Shade Clip</dt>
<dt>Shader Clip</dt>
<dd><p>Select a sub-range of the full colour map above.
By default the whole colour map is used, but if you want the range
of colours in the plot to be formed from only a part of the colour
band shown in the <label>Shader</label> control,
you can move the handles in from the end of this slider.
</p></dd>
<dt>Shade Log</dt>
<dd><p>Whether the aux scale should map linearly or logarithmically
into the colour map.
</p></dd>
<dt>Shade Flip</dt>
<dt>Shader Flip</dt>
<dd><p>Whether the aux scale should map forwards or backwards
into the colour map.
</p></dd>
<dt>Scaling</dt>
<dd><p>Determines the function used to map the range of aux data values
onto the colour map.
Options are <label>linear</label>,
<label>logarithmic</label>,
<label>square</label> and
<label>square root</label>.
</p></dd>
<dt>Null Colour</dt>
<dd><p>What colour should be used to represent points with a null value
for the aux data coordinate.
Expand Down Expand Up @@ -8039,17 +8043,34 @@ It has the following fields:
<p>The <label>Style</label> allows you to configure the way the spectrogram
is plotted. It has the following fields:
<dl>
<dt>Shader</dt>
<dt>Spectral Shader</dt>
<dd><p>Select the colour map from a list of options.
</p></dd>
<dt>Shade Log</dt>
<dd><p>Whether the aux scale should map linearly or logarithmically
into the colour map.
<dt>Shader Clip</dt>
<dd><p>Select a sub-range of the full colour map above.
By default the whole colour map is used, but if you want the range
of colours in the plot to be formed from only a part of the colour
band shown in the <label>Shader</label> control,
you can move the handles in from the end of this slider.
</p></dd>
<dt>Shade Flip</dt>
<dd><p>Whether the aux scale should map forwards or backwards
<dt>Shader Flip</dt>
<dd><p>Whether the spectral values should map forwards or backwards
into the colour map.
</p></dd>
<dt>Scaling</dt>
<dd><p>Determines the function used to map the range of spectral data values
onto the colour map.
Options are <label>linear</label>,
<label>logarithmic</label>,
<label>square</label> and
<label>square root</label>.
</p></dd>
<dt>Spectral Subrange</dt>
<dd><p>Adjusts the range of the spectral coordinate over which the
colour map is applied. By default the colour map is scaled using
limits found from the spectral data values themselves,
but you can restrict the range using this slider.
</p></dd>
<dt>Null Colour</dt>
<dd><p>What colour should be used to represent spectral samples with a null
value.
Expand Down Expand Up @@ -8769,7 +8790,6 @@ and plots a line linking the two points in a position pair.
<p>Configuration options are:
<dl>
<dt>Shading Mode</dt>
<dt>Shading Mode</dt>
<dd><p>See <ref id="ShapeMode"/>.
</p></dd>
</dl>
Expand Down Expand Up @@ -8969,7 +8989,7 @@ shapes plotted.
<p>This is like <ref id="mode-auto">Auto</ref> mode, but with more
user-configurable options. The options are:
<dl>
<dt>Map</dt>
<dt>Density Shader</dt>
<dd><p>The colour map for displaying density values.
There are two types, relative and absolute.
Relative maps have names marked by a star ("*"), and alter the
Expand All @@ -8978,22 +8998,26 @@ user-configurable options. The options are:
For a single-dataset plot, the absolute maps are best, but for
multiple subsets it may be less confusing to use a relative one.
</p></dd>
<dt>Map Clip</dt>
<dt>Shader Clip</dt>
<dd><p>Select only a part of the colour map selected above.
By default the whole colour map is used, but if you want the range
of colours in the plot to be formed from only a part of the colour
band shown in the <label>Shader</label> control,
you can move the handles in from the end of this slider.
</p></dd>
<dt>Log</dt>
<dd><p>Selects whether the colour map should be applied linearly or
logarithmically to the range of densities. The default is logarithmic.
</p></dd>
<dt>Flip</dt>
<dd><p>Selects whether the colour map should be applied forwards or
backwards to the range of densities.
<dt>Shader Flip</dt>
<dd><p>Whether the density scale should map forwards or backwards
into the colour map.
</p></dd>
<dt>Sub-range</dt>
<dt>Scaling</dt>
<dd><p>Determines the function used to map the range of density values
onto the colour map.
Options are <label>linear</label>,
<label>logarithmic</label>,
<label>square</label> and
<label>square root</label>.
</p></dd>
<dt>Density Subrange</dt>
<dd><p>Adjusts the density range over which the colour
map is applied. By default the colour map is scaled using limits
found from the data density in the plot (the most dense few pixels are
Expand Down Expand Up @@ -20801,6 +20825,11 @@ introduced since the last version:
in auto-format-detection mode.</li>
<li>Make VOTable handling more robust against unknown (illegal)
datatypes.</li>
<li>The <ref id="ShaderControl">Aux Axis</ref> control,
<ref id="mode-density">Density</ref> shading mode, and
<ref id="SpectrogramLayerControl">Spectrogram</ref> layer control
now provide a <label>Scaling</label> option for the colour map,
allowing use of Square and Sqrt mapping as well as Linear and Log.</li>
</ul>
</p></dd>

Expand Down
8 changes: 8 additions & 0 deletions ttools/src/docs/sun256.xml
Expand Up @@ -10112,6 +10112,14 @@ eds. C. Gabriel et al., ASP Conf. Ser. 351, p. 666 (2006)
in auto-format-detection mode.</li>
<li>Make VOTable handling more robust against unknown (illegal)
datatypes.</li>
<li>New parameters <code>auxfunc</code>, <code>densefuncN</code> and
<code>spectrofuncN</code> respectively
provide more flexibility in scaling functions
(Sqrt and Square as well as Linear and Logarithmic)
when using colour ramps in
<ref id="shading-aux">aux</ref> and
<ref id="shading-density">density</ref> shading modes, and
<ref id="layer-spectrogram">spectrogram</ref> layer.</li>
</ul>
</p></dd>

Expand Down

0 comments on commit 9f61949

Please sign in to comment.