|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.table.HealpixTableInfo
public class HealpixTableInfo
Defines how to store metadata in a table so that STIL knows it contains a HEALPix map.
Nested Class Summary | |
---|---|
static class |
HealpixTableInfo.HpxCoordSys
Characterises the coordinate systems defined by the HEALpix-FITS serialization convention. |
Field Summary | |
---|---|
static ValueInfo |
HPX_COLNAME_INFO
Metadata element for name of column storing pixel index. |
static ValueInfo |
HPX_CSYS_INFO
Metadata element for character indicating sky system: C, G or E. |
static ValueInfo |
HPX_ISNEST_INFO
Metadata element * for HEALPix ordering (true=NESTED, false=RING). |
static ValueInfo |
HPX_LEVEL_INFO
Metadata element for HEALPix level (=log2(nside)). |
Constructor Summary | |
---|---|
HealpixTableInfo(int level,
boolean isNest,
java.lang.String ipixColName,
HealpixTableInfo.HpxCoordSys csys)
Constructor. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
static HealpixTableInfo |
fromParams(java.util.List<DescribedValue> params)
Imports HEALPix information from a list of table parameters, and turns it into an instance of this class. |
HealpixTableInfo.HpxCoordSys |
getCoordSys()
Returns the HEALPix coordinate system variant used by this table. |
int |
getLevel()
Returns the HEALPix level. |
java.lang.String |
getPixelColumnName()
Returns the name of the table column containing the HEALPix pixel index. |
int |
hashCode()
|
static boolean |
isHealpix(java.util.List<DescribedValue> params)
Indicates whether a list of table parameters appears to be from a table with HEALPix annotations as expected by this class. |
boolean |
isNest()
Indicates pixel ordering scheme. |
DescribedValue[] |
toParams()
Exports the contents of this object to a list of DescribedValue objects that can be attached to a table's parameter list, to declare the organisation of HEALPix information in that table. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final ValueInfo HPX_LEVEL_INFO
STIL_HPX_LEVEL
", class Integer.
public static final ValueInfo HPX_ISNEST_INFO
STIL_HPX_ISNEST
", class Boolean.
public static final ValueInfo HPX_COLNAME_INFO
STIL_HPX_COLNAME
", class String.
public static final ValueInfo HPX_CSYS_INFO
STIL_HPX_CSYS
", class String.
Constructor Detail |
---|
public HealpixTableInfo(int level, boolean isNest, java.lang.String ipixColName, HealpixTableInfo.HpxCoordSys csys)
level
- healpix level; negative means not definedisNest
- true for nested, false for ringipixColName
- name of column containing pixel index,
or null for implicit pixel indicescsys
- healpix coordinate system variantMethod Detail |
---|
public int getLevel()
public boolean isNest()
public java.lang.String getPixelColumnName()
public HealpixTableInfo.HpxCoordSys getCoordSys()
public DescribedValue[] toParams()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public static boolean isHealpix(java.util.List<DescribedValue> params)
HPX_*
ValueInfos appears in the list, and returns
true if so.
This method may be useful to determine whether it's worth while
to call fromParams(java.util.List
.
params
- list of DescribedValue objects,
as obtained from Table.getParameters
public static HealpixTableInfo fromParams(java.util.List<DescribedValue> params)
params
- list of DescribedValue objects,
as obtained from Table.getParameters
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |