|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ast.AstObject
uk.ac.starlink.ast.Mapping
uk.ac.starlink.ast.GrismMap
public class GrismMap
Java interface to the AST GrismMap class - transform 1-dimensional coordinates using a grism dispersion equation. A GrismMap is a specialised form of Mapping which transforms 1-dimensional coordinates using the spectral dispersion equation described in FITS-WCS paper III "Representation of spectral coordinates in FITS". This describes the dispersion produced by gratings, prisms and grisms.
When initially created, the forward transformation of a GrismMap transforms input "grism parameter" values into output wavelength values. The "grism parameter" is a dimensionless value which is linearly related to position on the detector. It is defined in FITS-WCS paper III as "the offset on the detector from the point of intersection of the camera axis, measured in units of the effective local length". The units in which wavelength values are expected or returned is determined by the values supplied for the GrismWaveR, GrismNRP and GrismG attribute: whatever units are used for these attributes will also be used for the wavelength values.
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
Nested Class Summary |
---|
Nested classes/interfaces inherited from class uk.ac.starlink.ast.Mapping |
---|
Mapping.Interpolator, Mapping.Spreader |
Field Summary |
---|
Fields inherited from class uk.ac.starlink.ast.Mapping |
---|
LINEAR_INTERPOLATOR, LINEAR_SPREADER, NEAREST_INTERPOLATOR, NEAREST_SPREADER |
Fields inherited from class uk.ac.starlink.ast.AstObject |
---|
AST__BAD, AST__TUNULL, pointer |
Constructor Summary | |
---|---|
GrismMap()
Create a GrismMap. |
Method Summary | |
---|---|
double |
getGrismAlpha()
Get the angle of incidence of the incoming light on the grating surface. |
double |
getGrismEps()
Get The angle between the normal and the dispersion plane. |
double |
getGrismG()
Get the grating ruling density. |
int |
getGrismM()
Get the interference order. |
double |
getGrismNR()
Get the refractive index at the reference wavelength. |
double |
getGrismNRP()
Get the rate of change of refractive index with wavelength. |
double |
getGrismTheta()
Get angle between normal to detector plane and reference ray. |
double |
getGrismWaveR()
Get the reference wavelength. |
void |
setGrismAlpha(double grismAlpha)
Set the angle of incidence of the incoming light on the grating surface. |
void |
setGrismEps(double grismEps)
Set The angle between the normal and the dispersion plane. |
void |
setGrismG(double grismG)
Set the grating ruling density. |
void |
setGrismM(int grismM)
Set the interference order. |
void |
setGrismNR(double grismNR)
Set the refractive index at the reference wavelength. |
void |
setGrismNRP(double grismNRP)
Set the rate of change of refractive index with wavelength. |
void |
setGrismTheta(double grismTheta)
Set angle between normal to detector plane and reference ray. |
void |
setGrismWaveR(double grismWaveR)
Set the reference wavelength. |
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 |
Methods inherited from class java.lang.Object |
---|
clone, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GrismMap()
AstException
- if an error occurred in the AST libraryMethod Detail |
---|
public double getGrismAlpha()
public void setGrismAlpha(double grismAlpha)
grismAlpha
- the GrismAlpha attribute of this objectpublic double getGrismEps()
public void setGrismEps(double grismEps)
grismEps
- the GrismEps attribute of this objectpublic double getGrismG()
public void setGrismG(double grismG)
grismG
- the GrismG attribute of this objectpublic int getGrismM()
public void setGrismM(int grismM)
grismM
- the GrismM attribute of this objectpublic double getGrismNR()
public void setGrismNR(double grismNR)
grismNR
- the GrismNR attribute of this objectpublic double getGrismNRP()
public void setGrismNRP(double grismNRP)
grismNRP
- the GrismNRP attribute of this objectpublic double getGrismTheta()
public void setGrismTheta(double grismTheta)
grismTheta
- the GrismTheta attribute of this objectpublic double getGrismWaveR()
public void setGrismWaveR(double grismWaveR)
grismWaveR
- the GrismWaveR attribute of this object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |