uk.ac.starlink.ast
Class FluxFrame
java.lang.Object
uk.ac.starlink.ast.AstObject
uk.ac.starlink.ast.Mapping
uk.ac.starlink.ast.Frame
uk.ac.starlink.ast.FluxFrame
public class FluxFrame
- extends Frame
Java interface to the AST FluxFrame class
- measured flux description.
A FluxFrame is a specialised form of one-dimensional Frame which
represents various systems used to represent the signal level in an
observation. The particular coordinate system to be used is specified
by setting the FluxFrame's System attribute qualified, as necessary, by
other attributes such as the units, etc (see the description of the
System attribute for details).
All flux values are assumed to be measured at the same frequency or
wavelength (as given by the SpecVal attribute). Thus this class is
more appropriate for use with images rather than spectra.
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 FluxFrame
Constructor Summary |
FluxFrame()
Creates a FluxFrame with no default spectral value or frame. |
FluxFrame(double specval,
SpecFrame specfrm)
Creates a FluxFrame with given spectral frame and value. |
Method Summary |
double |
getSpecVal()
Get
the spectral position at which flux values are measured. |
void |
setSpecVal(double specVal)
Set
the spectral position at which flux values are measured. |
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 |
FluxFrame
public FluxFrame(double specval,
SpecFrame specfrm)
- Creates a FluxFrame with given spectral frame and value.
- Parameters:
specval
- The spectral value to which the flux values refer, given in the
spectral coordinate system specified by
"specfrm". The value supplied for the "specval"
parameter becomes the default value for the SpecVal attribute.
A value of AST__BAD may be supplied if the spectral position is
unknown, but this may result in it not being possible for the
astConvert
function to determine a Mapping between the new FluxFrame and
some other FluxFrame.specfrm
- A pointer to a SpecFrame describing the spectral coordinate system
in which the
"specval"
parameter is given. A deep copy of this object is taken, so any
subsequent changes to the SpecFrame using the supplied pointer will
have no effect on the new FluxFrame.
A NULL pointer can be supplied if AST__BAD is supplied for "specval".
- Throws:
AstException
- if an error occurred in the AST library
FluxFrame
public FluxFrame()
- Creates a FluxFrame with no default spectral value or frame.
getSpecVal
public double getSpecVal()
- Get
the spectral position at which flux values are measured.
This attribute specifies the spectral position (frequency, wavelength,
etc.), at which the values described by the FluxFrame are measured.
It is used when determining the Mapping between between FluxFrames.
The default value and spectral system used for this attribute are
both specified when the FluxFrame is created.
- Returns:
- this object's SpecVal attribute
setSpecVal
public void setSpecVal(double specVal)
- Set
the spectral position at which flux values are measured.
This attribute specifies the spectral position (frequency, wavelength,
etc.), at which the values described by the FluxFrame are measured.
It is used when determining the Mapping between between FluxFrames.
The default value and spectral system used for this attribute are
both specified when the FluxFrame is created.
- Parameters:
specVal
- the SpecVal attribute of this object
Copyright © 2019 Central Laboratory of the Research Councils. All Rights Reserved.