uk.ac.starlink.ast
Class ZoomMap
java.lang.Object
uk.ac.starlink.ast.AstObject
uk.ac.starlink.ast.Mapping
uk.ac.starlink.ast.ZoomMap
public class ZoomMap
- extends Mapping
Java interface to the AST ZoomMap class
- zoom coordinates about the origin.
The ZoomMap class implements a Mapping which performs a "zoom"
transformation by multiplying all coordinate values by the same
scale factor (the inverse transformation is performed by
dividing by this scale factor). The number of coordinate values
representing each point is unchanged.
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 ZoomMap
Constructor Summary |
ZoomMap(int ncoord,
double zoom)
Creates a ZoomMap. |
Method Summary |
double |
getZoom()
Get
zoomMap scale factor. |
void |
setZoom(double zoom)
Set
zoomMap scale factor. |
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 |
ZoomMap
public ZoomMap(int ncoord,
double zoom)
- Creates a ZoomMap.
- Parameters:
ncoord
- The number of coordinate values for each point to be
transformed (i.e. the number of dimensions of the space in
which the points will reside). The same number is applicable
to both input and output points.zoom
- Initial scale factor by which coordinate values should be
multiplied (by the forward transformation) or divided (by the
inverse transformation). This factor may subsequently be
changed via the ZoomMap's Zoom attribute. It may be positive
or negative, but should not be zero.
- Throws:
AstException
- if an error occurred in the AST library
getZoom
public double getZoom()
- Get
zoomMap scale factor.
This attribute holds the ZoomMap scale factor, by which
coordinate values are multiplied (by the forward transformation)
or divided (by the inverse transformation). This factor is set
when a ZoomMap is created, but may later be modified. The
default value is unity.
Note that if a ZoomMap is inverted (e.g. by using astInvert),
then the reciprocal of this zoom factor will, in effect, be
used.
Notes
- The Zoom attribute may not be set to zero.
- Returns:
- this object's Zoom attribute
setZoom
public void setZoom(double zoom)
- Set
zoomMap scale factor.
This attribute holds the ZoomMap scale factor, by which
coordinate values are multiplied (by the forward transformation)
or divided (by the inverse transformation). This factor is set
when a ZoomMap is created, but may later be modified. The
default value is unity.
Note that if a ZoomMap is inverted (e.g. by using astInvert),
then the reciprocal of this zoom factor will, in effect, be
used.
Notes
- The Zoom attribute may not be set to zero.
- Parameters:
zoom
- the Zoom attribute of this object
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.