papyri
{ } Raw JSON

bundles / astropy 7.0.1 / astropy / io / fits / column / Column / __init__

function

astropy.io.fits.column:Column.__init__

source: /astropy/io/fits/column.py :561

Signature

def   __init__ ( self ,  name = None ,  format = None ,  unit = None ,  null = None ,  bscale = None ,  bzero = None ,  disp = None ,  start = None ,  dim = None ,  array = None ,  ascii = None ,  coord_type = None ,  coord_unit = None ,  coord_ref_point = None ,  coord_ref_value = None ,  coord_inc = None ,  time_ref_pos = None )

Summary

Construct a Column by specifying attributes. All attributes except format can be optional; see astropy:column_creation and astropy:creating_ascii_table for more information regarding TFORM keyword.

Parameters

name : str, optional

column name, corresponding to TTYPE keyword

format : str

column format, corresponding to TFORM keyword

unit : str, optional

column unit, corresponding to TUNIT keyword

null : str, optional

null value, corresponding to TNULL keyword

bscale : int-like, optional

bscale value, corresponding to TSCAL keyword

bzero : int-like, optional

bzero value, corresponding to TZERO keyword

disp : str, optional

display format, corresponding to TDISP keyword

start : int, optional

column starting position (ASCII table only), corresponding to TBCOL keyword

dim : str, optional

column dimension corresponding to TDIM keyword

array : iterable, optional

a list, numpy.ndarray (or other iterable that can be used to initialize an ndarray) providing initial data for this column. The array will be automatically converted, if possible, to the data format of the column. In the case were non-trivial bscale and/or bzero arguments are given, the values in the array must be the physical values--that is, the values of column as if the scaling has already been applied (the array stored on the column object will then be converted back to its storage values).

ascii : bool, optional

set True if this describes a column for an ASCII table; this may be required to disambiguate the column format

coord_type : str, optional

coordinate/axis type corresponding to TCTYP keyword

coord_unit : str, optional

coordinate/axis unit corresponding to TCUNI keyword

coord_ref_point : int-like, optional

pixel coordinate of the reference point corresponding to TCRPX keyword

coord_ref_value : int-like, optional

coordinate value at reference point corresponding to TCRVL keyword

coord_inc : int-like, optional

coordinate increment at reference point corresponding to TCDLT keyword

time_ref_pos : str, optional

reference position for a time coordinate column corresponding to TRPOS keyword

Aliases

  • astropy.io.fits.Column.__init__