uk.ac.starlink.ast
Class Stc
java.lang.Object
uk.ac.starlink.ast.AstObject
uk.ac.starlink.ast.Mapping
uk.ac.starlink.ast.Frame
uk.ac.starlink.ast.Region
uk.ac.starlink.ast.Stc
- Direct Known Subclasses:
- StcCatalogEntryLocation, StcObsDataLocation, StcResourceProfile, StcSearchLocation
public abstract class Stc
- extends Region
Java interface to the AST Stc class
- represents an instance of the IVOA STC class.
The Stc class is an implementation of the IVOA STC class which forms
part of the IVOA Space-Time Coordinate Metadata system. See:
http://hea-www.harvard.edu/~arots/nvometa/STC.html
The Stc class does not have a constructor function of its own, as it
is simply a container class for a family of specialised sub-classes
including StcCatalogEntryLocation, StcResourceProfile, StcSearchLocation
and StcObsDataLocation.
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 Stc
Method Summary |
AstroCoords |
getStcCoord(int i)
Returns one of the AstroCoords elements stored within this
Stc when it was constructed. |
int |
getStcNCoord()
Returns the number of AstroCoords elements stored within
this Stc when it was constructed. |
Region |
getStcRegion()
Obtain a copy of the encapsulated Region within a Stc. |
Methods inherited from class uk.ac.starlink.ast.Region |
getAdaptive, getBounded, getClosed, getFillFactor, getMeshSize, getNegated, getRegionBounds, getRegionFrame, getRegionPoints, getUnc, mapRegion, mask, maskB, maskD, maskF, maskI, maskL, maskS, negate, overlap, setAdaptive, setClosed, setFillFactor, setMeshSize, setNegated, setUnc, showMesh |
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 |
getStcNCoord
public int getStcNCoord()
- Returns the number of AstroCoords elements stored within
this
Stc
when it was constructed.
- Returns:
- number of coords stored
getStcCoord
public AstroCoords getStcCoord(int i)
- Returns one of the AstroCoords elements stored within this
Stc
when it was constructed.
If the coordinate system represented by this Stc
has been changed since it was created (for instance, by
changing its System attribute), then the sizes and positions
in the returned AstroCoords
object
will reflect the change in coordinate system.
- Parameters:
i
- index of coords to retrieve. The first index is 1.
- Returns:
i
'th coord stored
getStcRegion
public Region getStcRegion()
- Obtain a copy of the encapsulated Region within a Stc.
This function returns a pointer to a deep copy of the Region
supplied when the Stc was created.
Notes
- A null Object pointer (AST__NULL) will be returned if this
function is invoked with the AST error status set, or if it
should fail for any reason.
- Returns:
- A pointer to a deep copy of the Region encapsulated within the
supplied Stc.
- Throws:
AstException
- if an error occurred in the AST library
Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.