Next: DRAWNORTH - Draws arrows parallel to the axes
Up: Specifications of KAPPA applications
Previous: DISPLAY - Displays a one- or two-dimensional NDF
DIV
- Divides one NDF data structure by another
- Description:
- The routine divides one NDF data structure by another
pixel-by-pixel to produce a new NDF.
- Usage:
-
div in1 in2 out
-
- Parameters:
-
IN1 = NDF (Read)
-
First NDF, to be divided by the second NDF.
-
IN2 = NDF (Read)
-
Second NDF, to be divided into the first NDF.
-
OUT = NDF (Write)
-
Output NDF to contain the ratio of the two input NDFs.
-
TITLE = LITERAL (Read)
-
The title for the output NDF. A null value will cause
the title of the NDF supplied for Parameter IN1 to be used
instead. [!]
- Examples:
- div a b c
- This divides the NDF called a by the NDF called b, to make the
NDF called c. NDF c inherits its title from a.
- div out=c in1=a in2=b title="Normalised data"
- This divides the NDF called a by the NDF called b, to make the
NDF called c. NDF c has the title "Normalised data".
- Notes:
- If the two input NDFs have different pixel-index bounds, then
they will be trimmed to match before being divided. An error will
result if they have no pixels in common.
-
Related Applications
:
- KAPPA: ADD,
CADD,
CDIV,
CMULT,
CSUB,
MATHS,
MULT,
SUB.
- Implementation Status:
- This routine correctly processes the AXIS, DATA, QUALITY,
LABEL, TITLE, UNITS,
HISTORY, WCS, and VARIANCE
components of an NDF data structure and propagates all extensions.
- Processing of bad pixels and automatic quality masking are supported.
- All non-complex numeric data types can be handled.
Calculations will be performed using either real or double
precision arithmetic, whichever is more appropriate. If the input
NDF structures contain values with other data types, then
conversion will be performed as necessary.
Next: DRAWNORTH - Draws arrows parallel to the axes
Up: Specifications of KAPPA applications
Previous: DISPLAY - Displays a one- or two-dimensional NDF
KAPPA --- Kernel Application Package
Starlink User Note 95
Malcolm J. Currie & David S. Berry
2013 February 14
E-mail:starlink@jiscmail.ac.uk
Copyright © 2013 Science and Technology Facilities Council