astropy 5.0

Parameters
_update_header_data(self, image_header, name=None, compression_type=None, tile_size=None, hcomp_scale=None, hcomp_smooth=None, quantize_level=None, quantize_method=None, dither_seed=None)

This method is mainly called internally, but a user may wish to call this method after assigning new data to the CompImageHDU object that is of a different type.

Parameters

image_header : `~astropy.io.fits.Header`

header to be associated with the image

name : str, optional

the EXTNAME value; if this value is :None:None:`None`, then the name from the input image header will be used; if there is no name in the input image header then the default name 'COMPRESSED_IMAGE' is used

compression_type : str, optional

compression algorithm 'RICE_1', 'PLIO_1', 'GZIP_1', 'GZIP_2', 'HCOMPRESS_1'; if this value is :None:None:`None`, use value already in the header; if no value already in the header, use 'RICE_1'

tile_size : sequence of int, optional

compression tile sizes as a list; if this value is :None:None:`None`, use value already in the header; if no value already in the header, treat each row of image as a tile

hcomp_scale : float, optional

HCOMPRESS scale parameter; if this value is :None:None:`None`, use the value already in the header; if no value already in the header, use 1

hcomp_smooth : float, optional

HCOMPRESS smooth parameter; if this value is :None:None:`None`, use the value already in the header; if no value already in the header, use 0

quantize_level : float, optional

floating point quantization level; if this value is :None:None:`None`, use the value already in the header; if no value already in header, use 16

quantize_method : int, optional

floating point quantization dithering method; can be either NO_DITHER (-1), SUBTRACTIVE_DITHER_1 (1; default), or SUBTRACTIVE_DITHER_2 (2)

dither_seed : int, optional

random seed to use for dithering; can be either an integer in the range 1 to 1000 (inclusive), DITHER_SEED_CLOCK (0; default), or DITHER_SEED_CHECKSUM (-1)

Update the table header (:None:None:`_header`) to the compressed image format and to match the input data (if any). Create the image header (:None:None:`_image_header`) from the input image header (if any) and ensure it matches the input data. Create the initially-empty table data array to hold the compressed data.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /astropy/io/fits/hdu/compressed.py#734
type: <class 'function'>
Commit: