ASDFFileHandler

class ginga.util.io.io_asdf.ASDFFileHandler(logger)[source]

Bases: BaseIOHandler

For loading ASDF data files.

Attributes Summary

mimetypes

name

Methods Summary

check_availability()

close()

load_asdf(asdf_f[, idx])

load_asdf_hdu_in_fits(fits_f, hdu, **kwargs)

* This is a special method that should only be called from WITHIN io_fits.py to open up ASDF-embedded-in-FITS *

load_file(filepath[, idx])

Load a single data object from a file.

load_idx(idx, **kwargs)

Parameters:

load_idx_cont(idx_spec, loader_cont_fn, **kwargs)

Parameters:

open_file(filepath, **kwargs)

Attributes Documentation

mimetypes = ['image/asdf']
name = 'asdf'

Methods Documentation

classmethod check_availability()[source]
close()[source]
load_asdf(asdf_f, idx=None, **kwargs)[source]
load_asdf_hdu_in_fits(fits_f, hdu, **kwargs)[source]

* This is a special method that should only be called from WITHIN io_fits.py to open up ASDF-embedded-in-FITS *

load_file(filepath, idx=None, **kwargs)[source]

Load a single data object from a file.

Parameters:
idx:py:Object

A Python value that matches describes the path or index to a single data data object in the file

kwargsoptional keyword arguments

Any optional keyword arguments are passed to the code that loads the data from the file

Returns:
data_objsubclass of ViewerObjectBase

A supported data wrapper object for a Ginga viewer

load_idx(idx, **kwargs)[source]
Parameters:
idx:py:class:object or None

A Python value that matches describes the path or index to a single data data object in the file. Can be None to indicate opening the default (or first usable) object. Acceptable formats are defined by the subclass.

kwargsoptional keyword arguments

Any optional keyword arguments are passed to the code that loads the data from the file

Returns:
data_objsubclass of ViewerObjectBase

A supported data wrapper object for a Ginga viewer

load_idx_cont(idx_spec, loader_cont_fn, **kwargs)[source]
Parameters:
idx_specstr

A string in the form of a pair of brackets enclosing some index expression matching data objects in the file

loader_cont_fnfunc (data_obj) -> None

A loader continuation function that takes a data object generated from loading an HDU and does something with it

kwargsoptional keyword arguments

Any optional keyword arguments are passed to the code that loads the data from the file

open_file(filepath, **kwargs)[source]