- Direct Known Subclasses:
public class CmpFrame
- extends Frame
Java interface to the AST CmpFrame class
- compound Frame.
A CmpFrame is a compound Frame which allows two component Frames
(of any class) to be merged together to form a more complex
Frame. The axes of the two component Frames then appear together
in the resulting CmpFrame (those of the first Frame, followed by
those of the second Frame).
Since a CmpFrame is itself a Frame, it can be used as a
component in forming further CmpFrames. Frames of arbitrary
complexity may be built from simple individual Frames in this
Also since a Frame is a Mapping, a CmpFrame can also be used as a
Mapping. Normally, a CmpFrame is simply equivalent to a UnitMap,
but if either of the component Frames within a CmpFrame is a Region
(a sub-class of Frame), then the CmpFrame will use the Region as a
Mapping when transforming values for axes described by the Region.
Thus input axis values corresponding to positions which are outside the
Region will result in bad output axis values.
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
- See Also:
- AST CmpFrame
Gets the component Frames from this CmpFrame.
|Methods inherited from class uk.ac.starlink.ast.Frame
angle, axAngle, axDistance, axOffset, convert, distance, findFrame, format, getActiveUnit, getAlignSystem, getBottom, getDigits, getDigits, getDirection, getDomain, getDut1, getEpoch, getFormat, getLabel, getMatchEnd, getMaxAxes, getMinAxes, getNaxes, getNormUnit, getObsLat, getObsLon, getPermute, getPreserveAxes, getSymbol, getSystem, getTitle, getTop, getUnit, intersect, norm, offset, offset2, permAxes, pickAxes, resolve, setActiveUnit, setAlignSystem, setBottom, setDigits, setDigits, setDirection, setDomain, setDut1, setEpoch, setEpoch, setFormat, setLabel, setMatchEnd, setMaxAxes, setMinAxes, setObsLat, setObsLon, setPermute, setPreserveAxes, setSymbol, setSystem, setTitle, setTop, setUnit, unformat
|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
public CmpFrame(Frame frame1,
- Create a CmpFrame.
frame1 - Pointer to the first component Frame.
frame2 - Pointer to the second component Frame.
AstException - if an error occurred in the AST library
public Frame decompose()
- Gets the component Frames from this CmpFrame.
This method returns pointers to two Frames which, when applied in
parallel, are equivalent to this CmpFrame.
- a two-element array giving the component Frames
AstException - if an error occurs in the AST library
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.