Skip to content

Commit

Permalink
KAPPA: Complete the SETQUAL (5bdab5e) LIKE change.
Browse files Browse the repository at this point in the history
- Increment minor version number for a new parameter.
- Add change to release notes.
- Stylistic consistency
  • Loading branch information
MalcolmCurrie committed Dec 13, 2013
1 parent 14bf281 commit 0f0a7d1
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
2 changes: 1 addition & 1 deletion applications/kappa/component.xml
Expand Up @@ -3,7 +3,7 @@
<!-- component.xml. Generated from component.xml.in by configure. -->

<component id="kappa" support="S">
<version>2.1-8</version>
<version>2.1-9</version>
<path>applications/kappa</path>
<description>KAPPA - Kernel Application Package</description>
<abstract><p>
Expand Down
2 changes: 1 addition & 1 deletion applications/kappa/configure.ac
Expand Up @@ -2,7 +2,7 @@ dnl Process this file with autoconf to produce a configure script
AC_REVISION($Revision$)

dnl Initialisation: package name and version number
AC_INIT(kappa, 2.1-8, starlink@jiscmail.ac.uk)
AC_INIT(kappa, 2.1-9, starlink@jiscmail.ac.uk)

dnl Require autoconf-2.50 at least
AC_PREREQ(2.50)
Expand Down
5 changes: 5 additions & 0 deletions applications/kappa/kappa.news.in
Expand Up @@ -68,6 +68,11 @@
- Now writes the number of pixels used to form the correlation
coefficient to output parameter NPIX.

o SETQUAL

- It is now possible to copy all quality information from one
NDF to another using a new parameter called LIKE.

1 KAPPA_Version_2.0

A new release of KAPPA (@PACKAGE_VERSION@) is available. The main
Expand Down
28 changes: 14 additions & 14 deletions applications/kappa/libndfpack/setqual.f
Expand Up @@ -21,12 +21,12 @@ SUBROUTINE SETQUAL( STATUS )

* Description:
* This routine assigns (or optionally removes) the quality
* specified by parameter QNAME to (or from) selected pixels in an
* specified by Parameter QNAME to (or from) selected pixels in an
* NDF. For more information about using quality within KAPPA see
* the appendix "Using Quality Names" within SUN/95.
*
* The user can select the pixels to be operated on in one of three
* ways (see parameter SELECT).
* ways (see Parameter SELECT).
*
* - By giving a `mask' NDF. Pixels with bad values in the mask NDF
* will be selected from the corresponding input NDF.
Expand All @@ -41,11 +41,11 @@ SUBROUTINE SETQUAL( STATUS )
* routine can be created interactively using the routine ARDGEN.
*
* The operation to be performed on the pixels is specified by
* parameter FUNCTION. The given quality may be assigned to or
* Parameter FUNCTION. The given quality may be assigned to or
* removed from pixels within the NDF. The pixels operated on
* can either be those selected by the user (as described above),
* or those not selected. The quality of all other pixels is left
* unchanged (unless the parameter FUNCTION is given the value NS+HU
* unchanged (unless the Parameter FUNCTION is given the value NS+HU
* or NU+HS). Thus for instance if pixel (1,1) already held the
* quality specified by QNAME, and the quality was then assigned to
* pixel (2,2) this would not cause the quality to be removed from
Expand Down Expand Up @@ -77,7 +77,7 @@ SUBROUTINE SETQUAL( STATUS )
* definition of the quality name.
* FUNCTION = LITERAL (Read)
* This parameter specifies what function is to be performed on
* the "selected" pixels specified using parameters MASK, LIST or
* the "selected" pixels specified using Parameters MASK, LIST or
* ARD. It can take any of the following values.
*
* - "HS" -- Ensure that the quality specified by QNAME is held by
Expand Down Expand Up @@ -106,23 +106,23 @@ SUBROUTINE SETQUAL( STATUS )
* and not held by any of the selected pixels.
* ["HS"]
* LIKE = NDF (Read)
* An existing NDF from which the quality component and quality names are
* An existing NDF from which the QUALITY component and quality names are
* to be copied. These overwrite any corresponding information in the
* NDF given by Parameter NDF. If null (!), then the operation of
* this command is instead determined by Parameter SELECT. [!]
* LIST = LITERAL (Read)
* A group of pixels positions within the input NDF listing the
* pixels that are to be `selected' (see parameter FUNCTION).
* pixels that are to be `selected' (see Parameter FUNCTION).
* Each position should be giving as a list of pixel indices
* (eg X1, Y1, X2, Y2,... for a two dimensional NDF). LIST is
* only prompted for if parameter SELECT is given the value LIST.
* only prompted for if Parameter SELECT is given the value LIST.
* MASK = NDF (Read)
* A mask NDF used to define the `selected' pixels within the
* input NDF (see parameter FUNCTION). The mask should be aligned
* input NDF (see Parameter FUNCTION). The mask should be aligned
* pixel-for-pixel with the input NDF. Pixels that are bad in
* the mask NDF are `selected'. The quality of any pixels that
* lie outside the bounds of the mask NDF are left unaltered.
* This parameter is only prompted for if the parameter SELECT is
* This parameter is only prompted for if the Parameter SELECT is
* given the value MASK.
* NDF = NDF (Update)
* The NDF in which the quality information is to be stored.
Expand All @@ -138,18 +138,18 @@ SUBROUTINE SETQUAL( STATUS )
* SELECT = LITERAL (Read)
* If Parameter LIKE is null, then this parameter determines how
* the pixels are selected, and can take the values "Mask",
* "List" or "ARD" (see parameters MASK, LIST, and ARD). ["Mask"]
* "List" or "ARD" (see Parameters MASK, LIST, and ARD). ["Mask"]
* XNAME = LITERAL (Read)
* If an NDF already contains any quality name definitions then
* new quality names are put in the same extension as the old
* names. If no previous quality names have been stored in the
* NDF then parameter XNAME will be used to obtain the name of an
* NDF then Parameter XNAME will be used to obtain the name of an
* NDF extension in which to store the new quality name. The
* extension will be created if it does not already exist (see
* parameter XTYPE). [QUALITY_NAMES]
* Parameter XTYPE). [QUALITY_NAMES]
* XTYPE = LITERAL (Read)
* If a new NDF extension is created to hold quality names (see
* parameter XNAME), then parameter XTYPE is used to obtain the
* Parameter XNAME), then Parameter XTYPE is used to obtain the
* HDS data type for the created extension. The run time default
* is to give the extension a type identical to its name. []

Expand Down
9 changes: 7 additions & 2 deletions applications/kappa/sun95.tex
Expand Up @@ -15,7 +15,7 @@
\newcommand{\stardocsource} {sun95.40}
\newcommand{\stardocnumber} {95.40}
\newcommand{\stardocauthors} {Malcolm J. Currie \& David S. Berry}
\newcommand{\stardocdate} {2013 December 6}
\newcommand{\stardocdate} {2013 December 12}
\newcommand{\stardoctitle} {KAPPA --- Kernel Application Package}
\newcommand{\stardocversion} {2.1}
\newcommand{\stardocmanual} {User's Guide}
Expand Down Expand Up @@ -46750,7 +46750,7 @@ \subsection{Explanatory Notes}
\sstsubsection{
LIKE = NDF (Read)
}{
An existing NDF from which the quality component and quality names are
An existing NDF from which the QUALITY component and quality names are
to be copied. These overwrite any corresponding information in the
NDF given by Parameter NDF. If null ({\tt{!}}), then the operation of
this command is instead determined by Parameter SELECT. {\tt [!]}
Expand Down Expand Up @@ -59150,6 +59150,11 @@ \subsection{Modified Commands}
\item Now writes the number of pixels used to form the correlation
coefficient to output parameter NPIX.
\end{itemize}
\item [\htmlref{SETQUAL}{SETQUAL}]\mbox{}
\begin{itemize}
\item It is now possible to copy all quality information from one
NDF to another using a new parameter called LIKE.
\end{itemize}
\end{description}

\begin{latexonly}
Expand Down

0 comments on commit 0f0a7d1

Please sign in to comment.