Fits

Instance Constructors

new Fits(hdfsPath: Path, conf: Configuration, hduIndex: Int)

hdfsPath
: (Path) Hadoop path containing informations on the file to read.
conf
: (Configuration) Hadoop configuration containing informations on the run.
hduIndex
: (Int) Index of the HDU to read (zero-based).

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val blockBoundaries: FitsBlockBoundaries
val blockHeader: Array[String]
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val data: FSDataInputStream
val empty_hdu: Boolean
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val fs: FileSystem
def getBlockBoundaries: FitsBlockBoundaries

Compute the indices of the first and last bytes of the HDU: hdu_start=header_start, data_start, data_stop, hdu_stop
Compute the indices of the first and last bytes of the HDU: hdu_start=header_start, data_start, data_stop, hdu_stop
returns
(FitsBlockBoundaries), Instance of FitsBlockBoundaries initialised with the boundaries of the FITS HDU (header+data).
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getDataLen(keyValues: Map[String, String]): Long

Compute the size of a data block.
Compute the size of a data block.
keyValues
: (Map[String, String]) Values from the header (see parseHeader)
returns
(Long) Size of the corresponding data block
def getHduType: String

Check the type of HDU.
Check the type of HDU. Available: BINTABLE, IMAGE, or EMPTY. If not registered, returns NOT UNDERSTOOD. Note: Not working if an image is stored in a primary HDU... TBD.
returns
(String) The kind of HDU data.
def getHeaderComments(header: Array[String]): Map[String, String]

Get the comments of the header.
Get the comments of the header. We assume the comments are written after a backslash (\).
header
: (Array[String]) The header of the HDU.
returns
(Map[String, String]), a map of keyword/comment.
def getNHDU: Int

Return the number of HDUs in the FITS file.
Return the number of HDUs in the FITS file.
returns
(Int) the number of HDU.
def getRow(buf: Array[Byte]): List[_]

Convert binary row into row.
Convert binary row into row. You need to have the cursor at the beginning of a row. Example
```
// Set the cursor at the beginning of the data block
setCursor(BlockBoundaries.dataStart)
// Initialise your binary row
val buffer = Array[Byte](size_of_one_row_in_bytes)
// Read the first binary row into buffer
data.read(buffer, 0, size_of_one_row_in_bytes)
// Convert buffer
val myrow = getRow(buffer)
```
buf
: (Array[Byte]) Row of bytes read from the data block.
returns
(List[_]) The row as list of elements (float, int, string, etc.) with types as given by the header.
def handleBintable: BintableHDU

Give access to methods concerning BinTable HDU.
Give access to methods concerning BinTable HDU.
returns
(BintableHDU)
def handleImage: ImageHDU

Give access to methods concerning Image HDU.
Give access to methods concerning Image HDU.
returns
(ImageHDU)
def hashCode(): Int

Definition Classes
AnyRef → Any
val hdu: HDU
val hduType: String
val isHDUBelowMax: Boolean
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val key: String
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val numberOfHdus: Int
def readFullHeaderBlocks: Array[String]

Read all header blocks of a HDU.
Read all header blocks of a HDU. The cursor needs to be at the start of the header.
returns
(Array[String) the header is an array of Strings, each String being one line of the header.
def readHeaderBlock: Array[String]

Read one header block of a HDU.
Read one header block of a HDU. The cursor needs to be at the start of the block. We assume that each header row has a standard size of 80 Bytes, and the total size of the header is 2880 Bytes.
returns
(Array[String) the header block is an array of Strings, each String being one line of the header.
def registerHeader: Unit

Register the header in the Hadoop configuration.
Register the header in the Hadoop configuration. By doing this, we broadcast the header to the executors. The header is sent as a long String, and can be read properly afterwards using retrieveHeader. Make sure you use the same separators.
def resetCursorAtData: Unit

Place the cursor at the beginning of the data of the block
def resetCursorAtHeader: Unit

Place the cursor at the beginning of the header of the block
def retrieveHeader: Array[String]

Retrieve the header from the Hadoop configuration.
Retrieve the header from the Hadoop configuration. Make sure you use the same separators as in registerHeader.
returns
the header as Array[String]. See readHeader.
def setCursor(position: Long): Unit

Set the cursor at the position (byte index, Long).
Set the cursor at the position (byte index, Long).
position
: (Long) The byte index to seek in the file.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package FitsLib

class Fits extends AnyRef

Instance Constructors

new Fits(hdfsPath: Path, conf: Configuration, hduIndex: Int)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val blockBoundaries: FitsBlockBoundaries

val blockHeader: Array[String]

def clone(): AnyRef

val data: FSDataInputStream

val empty_hdu: Boolean

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val fs: FileSystem

def getBlockBoundaries: FitsBlockBoundaries

final def getClass(): Class[_]

def getDataLen(keyValues: Map[String, String]): Long

def getHduType: String

def getHeaderComments(header: Array[String]): Map[String, String]

def getNHDU: Int

def getRow(buf: Array[Byte]): List[_]

def handleBintable: BintableHDU

def handleImage: ImageHDU

def hashCode(): Int

val hdu: HDU

val hduType: String

val isHDUBelowMax: Boolean

final def isInstanceOf[T0]: Boolean

val key: String

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val numberOfHdus: Int

def readFullHeaderBlocks: Array[String]

def readHeaderBlock: Array[String]

def registerHeader: Unit

def resetCursorAtData: Unit

def resetCursorAtHeader: Unit

def retrieveHeader: Array[String]

def setCursor(position: Long): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped