Commit 7e79f576 authored by Cory Quammen's avatar Cory Quammen

Update Automatic Rescale Range Mode docs

parent 04255486
......@@ -244,12 +244,25 @@ the \ui{Use log scale when mapping data to colors}. It is assumed that the data
is in the non-zero, positive range. \ParaView will report errors and try to
automatically fix the range if it is ever invalid for log mapping.
Based on the user preference set in the \ui{Settings} dialog, \ParaView can
automatically rescale the transfer function every time when the user hits the
\ui{Apply} button on the \ui{Properties} panel or when the time step changes.
This behavior can be disabled by unchecking the \ui{Automatically rescale
transfer functions to fit data} checkbox. When unchecked, whatever scalar range
you specify for the transfer function will remain unchanged.
The range of a color map is a very important property that controls the mapping
of data values to colors. The range can be automatically updated in a number
of situations for convenience. How the range is updated is controlled by the
\ui{Automatic Rescale Range Mode} property in the \ui{Color Map Editor}. When
\ui{Never} is selected, the data range will never be updated automatically. When
\ui{Grow and update on 'Apply'} is selected, \ParaView will grow the color/opacity
map range to include the current data range every time you hit \ui{Apply} on the
\ui{Properties} panel. Thus, when the data range changes, if the timestep is changed,
the color/opacity map range won't be affected. To grow the range on change in
timestep as well, use the \ui{Grow and update every timestep} option. Now the
range will be updated on \ui{Apply} as well as when the timestep changes.
\emph{Grow} indicates that the color/opacity map range will only be increased,
never shrunk, to include the current data range. If you want the range to
match the current data range exactly, then you should use the \ui{Clamp and
update every timestep} option. Now the range will be clamped to the exact data
range each time you hit \ui{Apply} on the \ui{Properties} panel or when the
timestep changes. The initial value for the \ui{Automatic Rescale Range Mode}
is controlled by the \ui{General} setting \ui{Transfer Function Reset Mode} in the
\ui{Settings} dialog (see Section~\ref{sec:GeneralSettings}).
\subsection{Transfer function editor}
......
......@@ -40,6 +40,7 @@ advanced options with the \icon{Images/pqAdvanced26.png} button or search for th
option using the \ui{Search} box.
\section{\texttt{General} settings}
\label{sec:GeneralSettings}
\keyword{General Settings}
\begin{figure}[htb]
......@@ -49,26 +50,34 @@ option using the \ui{Search} box.
\caption{\ui{Settings} dialog in \paraview showing the \ui{General} settings tab.}
\end{center}
\end{figure}
\fixme{Update figure}
\begin{description}
\item[\ui{General Options}]~
\begin{itemize}
\item \ui{Show Splash Screen}: Uncheck this to not show the splash screen at
\item \ui{Show Welcome Dialog}: Uncheck this to not show the welcome screen at
application startup. You will need to restart \paraview to see the effect.
\icon{Images/pqAdvanced26.png}
\item \ui{Show Save State On Exit}: When this is checked \paraview will prompt you
to save a state file when you exit the application. \icon{Images/pqAdvanced26.png}
\item \ui{Crash Recovery}: When this is checked, \paraview will intermittently
save a backup state file as you make changes in the visualization pipeline.
If \paraview crashes for some reason, then when you relaunch \paraview, it
will provide you with a choice to load the backup state saved before the crash
occurred. This is not $100\%$ reliable, but some users may find it useful to
avoid losing their visualization state due to a crash.
\icon{Images/pqAdvanced26.png}
avoid losing their visualization state due to a crash. \icon{Images/pqAdvanced26.png}
\item \ui{Force Single Column Menus}: On platforms that support multicolumn menus,
force all menu items to appear in a single scrollable column. This is useful to
ensure all menu items are selectable on low-resolution screens.
\end{itemize}
\item[\ui{GUI Font}]~
\begin{itemize}
\item \ui{Override Font}: When checked, use a custom font size for the user interface.
This overrides the system default font size.
\item \ui{Font Size}: The size of the font to use for UI elements.
\end{itemize}
\item \ui{Show Save State On Exit}: When this is checked \paraview will prompt you
to save a state file when you exit the application.
\item[\ui{Default View}]~
\item[\ui{View Options}]~
\begin{itemize}
\item \ui{Default View Type}: When \paraview starts up, it
creates \ui{Render View} by default. You can use this option to change the
......@@ -107,23 +116,12 @@ option using the \ui{Search} box.
\item[\ui{Color/Opacity Map Range Options}]~
\begin{itemize}
\item \ui{Transfer Function Reset Mode}: This setting controls when \ParaView
\item \ui{Transfer Function Reset Mode}: This setting controls the initial
settings for how \ParaView
will reset the ranges for color and opacity maps (or transfer functions). This
only affects those color/opacity maps that have the \ui{Automatically rescale
transfer functions to fit data} setting enabled (Section~\ref{sec:ColorMapping:MappingData}).
When \ui{Grow and update on 'Apply'} is selected, \ParaView will grow the
color/opacity map range to include the current data range every time you hit
\ui{Apply} on the \ui{Properties} panel.
Thus, when the data range changes, if the timestep is changed, the
color/opacity map range won't be affected. To grow the range on change in
timestep as well, use the \ui{Grow and update every timestep} option. Now the
range will be updated on \ui{Apply} as well as when the timestep changes.
\emph{Grow} indicates that the color/opacity map range will only be increased, never shrunk,
to include the current data range. If you want the range to
match the current data range exactly, then you should use the \ui{Clamp and
update every timestep} option. Now the range will be clamped to the exact data
range each time you hit \ui{Apply} on the \ui{Properties} panel or when the
timestep changes.
sets the initial value of the \ui{Automatic Rescale Range Mode} for newly created
color/opacity maps (Section~\ref{sec:ColorMapping:MappingData}). This setting can
be changed on a per-color map basis after the color map has been created.
\fixme{Update this setting.}
\item \ui{Scalar Bar Mode}: This settings controls how \paraview
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment