cds.moc

Class MocIO

java.lang.Object

cds.moc.MocIO

public final class MocIO
extends Object

HEALPix Multi Order Coverage Map (MOC) IO routines Compliante with IVOA MOC Rec 1.0 June 2014 Example : HealpixMoc moc = new HealpixMoc(); (new IO(moc).read(String filename);

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASCII
static int	FITS
static int	JSON
static int	JSON0
static String	OLDSIGNATURE
static String	SIGNATURE

Constructor Summary

Constructors

Constructor and Description
MocIO(HealpixMoc m)

Method Summary

Modifier and Type	Method and Description
void	createUniq(int nval, int nbyte, byte[] t)
void	read(InputStream in) Read HEALPix MOC from a stream.
void	read(InputStream in, int mode) Deprecated. see read(InputStream)
void	read(String filename) Read HEALPix MOC from a file.
void	read(String filename, int mode) Deprecated. see read(String)
void	readASCII(InputStream in) Read MOC from an ASCII stream Support simultaneously various ASCII formats (OBSOLETE, ASCII & JSON) ASCII (with a first comment for providing the MOCORDER) #MOCORDER MAX ORDER1/nn1,nn2-nnX ORDER2/...
void	readFits(InputStream in) Read HEALPix MOC from an Binary FITS stream
void	write(OutputStream out) Write HEALPix MOC to an output stream
void	write(OutputStream out, int mode) Write HEALPix MOC to an output stream At the end, the stream is not closed
void	write(String filename) Write HEALPix MOC to a file
void	write(String filename, int mode) Write HEALPix MOC to a file
void	writeASCII(OutputStream out) Write HEALPix MOC to an output stream IN ASCII encoded format
void	writeFits(OutputStream out) Write HEALPix MOC to an output stream in FITS encoded format
void	writeJSON(OutputStream out) Write HEALPix MOC to an output stream IN JSON encoded format

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FITS

public static final int FITS

See Also:

Constant Field Values

JSON

public static final int JSON

See Also:

Constant Field Values

ASCII

public static final int ASCII

See Also:

Constant Field Values

JSON0

public static final int JSON0

See Also:

Constant Field Values

OLDSIGNATURE

public static final String OLDSIGNATURE

See Also:

Constant Field Values

SIGNATURE

public static final String SIGNATURE

See Also:

Constant Field Values

Constructor Detail

MocIO

public MocIO(HealpixMoc m)

Method Detail

read

public void read(String filename)
          throws Exception

Read HEALPix MOC from a file. Support standard FITS format and ASCII non standard alternatives (JSON, ASCII)

Parameters:

filename - file name

Throws:

Exception

read

public void read(String filename,
                 int mode)
          throws Exception

Deprecated. see read(String)

Read HEALPix MOC from a file.

Parameters:

filename - file name

mode - MOC format: FITS, JSON, ASCII

Throws:

Exception

read

public void read(InputStream in)
          throws Exception

Read HEALPix MOC from a stream. Support standard FITS format and ASCII non standard alternatives (JSON, ASCII)

Parameters:

in - input stream

Throws:

Exception

read

public void read(InputStream in,
                 int mode)
          throws Exception

Deprecated. see read(InputStream)

Read HEALPix MOC from a stream.

Parameters:

in - input stream

mode - MOC format: FITS, JSON, ASCII

Throws:

Exception

readASCII

public void readASCII(InputStream in)
               throws Exception

Read MOC from an ASCII stream Support simultaneously various ASCII formats (OBSOLETE, ASCII & JSON) ASCII (with a first comment for providing the MOCORDER) #MOCORDER MAX ORDER1/nn1,nn2-nnX ORDER2/... ASCII (with an explicit MAXORDER possibly empty list) ORDER1/nn1,nn2-nnX ORDER2/... MAXORDER/ JSON (with an explicit MAXORDER possibly empty list) {"ORDER1":[nn1,nn2,...], "ORDER2":[nn...] ... "MAXORDER":[] } OBSOLETE JSON (with a first comment for providing the MOCORDER => Not well formed JSON) #MOCORDER MAX {"ORDER1":[nn1,nn2,...], "ORDER2":[nn ... } OBSOLETE ASCII #MOCORDER MAX ORDER|NSIDE=xxx1 nn1 nn2-nn3 nn4 ... NSIDE|ORDER=xxx2 ...

Parameters:

in - input stream

Throws:

Exception

readFits

public void readFits(InputStream in)
              throws Exception

Read HEALPix MOC from an Binary FITS stream

Throws:

Exception

write

public void write(String filename)
           throws Exception

Write HEALPix MOC to a file

Parameters:

filename - name of file

Throws:

Exception

write

public void write(String filename,
                  int mode)
           throws Exception

Write HEALPix MOC to a file

Parameters:

filename - name of file

mode - encoded format (FITS or JSON)

Throws:

Exception

write

public void write(OutputStream out)
           throws Exception

Write HEALPix MOC to an output stream

Parameters:

out - output stream

Throws:

Exception

write

public void write(OutputStream out,
                  int mode)
           throws Exception

Write HEALPix MOC to an output stream At the end, the stream is not closed

Parameters:

out - output stream

mode - encoded format (FITS or JSON or ASCII)

Throws:

Exception

writeASCII

public void writeASCII(OutputStream out)
                throws Exception

Write HEALPix MOC to an output stream IN ASCII encoded format

Parameters:

out - output stream

Throws:

Exception

writeJSON

public void writeJSON(OutputStream out)
               throws Exception

Write HEALPix MOC to an output stream IN JSON encoded format

Parameters:

out - output stream

Throws:

Exception

writeFits

public void writeFits(OutputStream out)
               throws Exception

Write HEALPix MOC to an output stream in FITS encoded format

Parameters:

out - output stream

Throws:

Exception

createUniq

public void createUniq(int nval,
                       int nbyte,
                       byte[] t)
                throws Exception

Throws:

Exception