uk.ac.starlink.ast
Class RateMap
java.lang.Object
uk.ac.starlink.ast.AstObject
uk.ac.starlink.ast.Mapping
uk.ac.starlink.ast.RateMap
public class RateMap
- extends Mapping
Java interface to the AST RateMap class
- mapping which represents differentiation.
A RateMap is a Mapping which represents a single element of the
Jacobian matrix of another Mapping. The Mapping for which the
Jacobian is required is specified when the new RateMap is created,
and is referred to as the "encapsulated Mapping" below.
The number of inputs to a RateMap is the same as the number of inputs
to its encapsulated Mapping. The number of outputs from a RateMap
is always one. This one output equals the rate of change of a
specified output of the encapsulated Mapping with respect to a
specified input of the encapsulated Mapping (the input and output
to use are specified when the RateMap is created).
A RateMap which has not been inverted does not define an inverse
transformation. If a RateMap has been inverted then it will define
an inverse transformation but not a forward transformation.
Licence
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public Licence as
published by the Free Software Foundation; either version 2 of
the Licence, or (at your option) any later version.
This program is distributed in the hope that it will be
useful,but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public Licence for more details.
You should have received a copy of the GNU General Public Licence
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street,Fifth Floor, Boston, MA
02110-1301, USA
- See Also:
- AST RateMap
Constructor Summary |
RateMap(Mapping map,
int ax1,
int ax2)
Create a RateMap. |
Methods inherited from class uk.ac.starlink.ast.Mapping |
decompose, getInvert, getNin, getNout, getReport, getTranForward, getTranInverse, invert, linearApprox, mapBox, mapSplit, rate, rebin, rebinD, rebinF, rebinI, resample, resampleB, resampleD, resampleF, resampleI, resampleL, resampleS, setInvert, setReport, simplify, tran1, tran2, tranGrid, tranN, tranP |
Methods inherited from class uk.ac.starlink.ast.AstObject |
annul, clear, copy, delete, equals, finalize, getAstConstantI, getB, getC, getD, getF, getI, getID, getIdent, getL, getNobject, getObjSize, getRefCount, hashCode, isThreaded, reportVersions, sameObject, set, setB, setC, setD, setF, setI, setID, setIdent, setL, show, test, tune |
RateMap
public RateMap(Mapping map,
int ax1,
int ax2)
- Create a RateMap.
- Parameters:
map
- Pointer to the encapsulated Mapping.ax1
- Index of the output from the encapsulated Mapping for which the
rate of change is required. This corresponds to the delta
quantity forming the numerator of the required element of the
Jacobian matrix. The first axis has index 1.ax2
- Index of the input to the encapsulated Mapping which is to be
varied. This corresponds to the delta quantity forming the
denominator of the required element of the Jacobian matrix.
The first axis has index 1.
- Throws:
AstException
- if an error occurred in the AST library
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.