BintableHDU

Instance Constructors

new BintableHDU(header: Array[String], selectedColumns: List[String] = null)

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
val BYTE_SIZE: Int

Definition Classes
HDU
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val colNames: Map[String, String]
val colPositions: List[Int]
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getColType(keyValues: Map[String, String], colIndex: Int): String

Get the type of the elements of a column with index colIndex of a HDU.
Get the type of the elements of a column with index colIndex of a HDU.
keyValues
: (Map[String, String]) The header of the HDU.
colIndex
: (Int) Index (zero-based) of a column.
returns
(String), the type (FITS convention) of the elements of the column.
def getColTypes(keyValues: Map[String, String]): List[String]

Return the types of elements for each column as a list.
Return the types of elements for each column as a list.
keyValues
: (Map[String, String]) keyValues from the header of the HDU (see parseHeader).
returns
(List[String]), list with the types of elements for each column as given by the header.

Definition Classes
BintableHDU → HDU
def getColumnPos(keyValues: Map[String, String], colName: String): Int

Get the position (zero based) of a column with name colName of a HDU.
Get the position (zero based) of a column with name colName of a HDU.
colName
: (String) The name of the column
returns
(Int), position (zero-based) of the column.
def getElementFromBuffer(subbuf: Array[Byte], fitstype: String): Any

Convert one array of bytes corresponding to one element of the table into its primitive type.
Convert one array of bytes corresponding to one element of the table into its primitive type.
subbuf
: (Array[Byte]) Array of byte describing one element of the table.
fitstype
: (String) The type of this table element according to the header.
returns
the table element converted from binary.

Definition Classes
HDU
def getNCols(keyValues: Map[String, String]): Long

Get the number of column of a HDU.
Get the number of column of a HDU. We rely on what's written in the header, meaning here we do not access the data directly.
keyValues
: (Map[String, String]) keyValues from the header of the HDU (see parseHeader).
returns
(Long), the number of rows as written in KEYWORD=TFIELDS.

Definition Classes
BintableHDU → HDU
def getNRows(keyValues: Map[String, String]): Long

Get the number of row of a HDU.
Get the number of row of a HDU. We rely on what's written in the header, meaning here we do not access the data directly.
keyValues
: (Map[String, String]) keyValues from the header of the HDU (see parseHeader).
returns
(Long), the number of rows as written in KEYWORD=NAXIS2.

Definition Classes
BintableHDU → HDU
def getRow(buf: Array[Byte]): List[Any]

Convert a bintable row from binary to primitives.
Convert a bintable row from binary to primitives.
buf
: (Array[Byte]) Array of bytes.
returns
(List[Any]) : Decoded row as a list of primitives.

Definition Classes
BintableHDU → HDU
def getSizeRowBytes(keyValues: Map[String, String]): Int

Get the size (bytes) of each row of a HDU.
Get the size (bytes) of each row of a HDU. We rely on what's written in the header, meaning here we do not access the data directly.
keyValues
: (Map[String, String]) keyValues from the header of the HDU (see parseHeader).
returns
(Int), the size (bytes) of one row as written in KEYWORD=NAXIS1.

Definition Classes
BintableHDU → HDU
def getSplitLocation(fitstype: String): Int

Companion routine to rowSplitLocations.
Companion routine to rowSplitLocations. Returns the size of a primitive according to its type from the FITS header.
fitstype
: (String) Element type according to FITS standards (I, J, K, E, D, L, A, etc)
returns
(Int), the size (bytes) of the element.
val header: Array[String]
def implemented: Boolean

Bintables are implemented
Bintables are implemented
returns
(Boolean)

Definition Classes
BintableHDU → HDU
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val keyValues: Map[String, String]
def listOfStruct: List[StructField]

Build a list of StructField from header information.
Build a list of StructField from header information. The list of StructField is then used to build the DataFrame schema.
returns
(List[StructField]) List of StructField with column name, column type, and whether the column is nullable.

Definition Classes
BintableHDU → HDU
val ncols: Int
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def rowSplitLocations(rowTypes: List[String], col: Int = 0): List[Int]

Description of a row in terms of bytes indices.
Description of a row in terms of bytes indices. rowSplitLocations returns an array containing the position of elements (byte index) in a row. Example if we have a row with [20A, E, E], one will have rowSplitLocations -> [0, 20, 24, 28] that is a string on 20 Bytes, followed by 2 floats on 4 bytes each.
col
: (Int) Column position used for the recursion. Should be left at 0.
returns
(List[Int]), the position of elements (byte index) in a row.
val rowTypes: List[String]
val selectedColNames: List[String]
val selectedColumns: List[String]
val splitLocations: List[Int]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
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 FitsHduBintable

case class BintableHDU(header: Array[String], selectedColumns: List[String] = null) extends HDU with Product with Serializable

Instance Constructors

new BintableHDU(header: Array[String], selectedColumns: List[String] = null)

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val BYTE_SIZE: Int

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val colNames: Map[String, String]

val colPositions: List[Int]

final def eq(arg0: AnyRef): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getColType(keyValues: Map[String, String], colIndex: Int): String

def getColTypes(keyValues: Map[String, String]): List[String]

def getColumnPos(keyValues: Map[String, String], colName: String): Int

def getElementFromBuffer(subbuf: Array[Byte], fitstype: String): Any

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

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

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

def getSizeRowBytes(keyValues: Map[String, String]): Int

def getSplitLocation(fitstype: String): Int

val header: Array[String]

def implemented: Boolean

final def isInstanceOf[T0]: Boolean

val keyValues: Map[String, String]

def listOfStruct: List[StructField]

val ncols: Int

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def rowSplitLocations(rowTypes: List[String], col: Int = 0): List[Int]

val rowTypes: List[String]

val selectedColNames: List[String]

val selectedColumns: List[String]

val splitLocations: List[Int]

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from HDU

Inherited from AnyRef

Inherited from Any

Ungrouped