`astrohack.io.dio`¶

Module Contents¶

Functions¶

`open_beamcut`(file: str) → Union[astrohack.io.beamcut_mds.AstrohackBeamcutFile, None]	Open beamcut file and return instance of the beamcut data object. Object includes summary function to list available nodes.
`open_holog`(file: str) → Union[astrohack.io.holog_mds.AstrohackHologFile, None]	Open holog file and return instance of the holog data object. Object includes summary function to list available dictionary keys.
`open_image`(file: str) → Union[astrohack.io.image_mds.AstrohackImageFile, None]	Open image file and return instance of the image data object. Object includes summary function to list available dictionary keys.
`open_panel`(file: str) → Union[astrohack.io.panel_mds.AstrohackPanelFile, None]	Open panel file and return instance of the panel data object. Object includes summary function to list available dictionary keys.
`open_locit`(file: str) → Union[astrohack.io.locit_mds.AstrohackLocitFile, None]	Open locit file and return instance of the locit data object. Object includes summary function to list available dictionary keys.
`open_position`(file: str) → Union[astrohack.io.position_mds.AstrohackPositionFile, None]	Open position file and return instance of the position data object. Object includes summary function to list available dictionary keys.
`open_pointing`(file: str) → Union[astrohack.io.point_mds.AstrohackPointFile, None]	Open pointing file and return instance of the pointing data object. Object includes summary function to list available dictionary keys.

open_beamcut(file: str) → Union[astrohack.io.beamcut_mds.AstrohackBeamcutFile, None][source]¶

Open beamcut file and return instance of the beamcut data object. Object includes summary function to list available nodes.

Parameters: file (str) – Path to beamcut file.
Returns: beamcut object; None if file not found.
Return type: AstrohackBeamcutFile

AstrohackBeamcutFile Beamcu object allows the user to access beam cut data via a xarray data tree, in order of depth, ant -> ddi -> cut. The beamcut object also provides a summary() helper function to list available nodes for each file. An outline of the beam object structure is show below:

beamcut_mds =
    {
        ant_0:{
            ddi_0:{
                 cut_0: beamcut_ds,
                     ⋮
                 cut_n: beamcut_ds
            },
            ⋮
            ddi_n: …
        },
        ⋮
        ant_n: …
    }

open_holog(file: str) → Union[astrohack.io.holog_mds.AstrohackHologFile, None][source]¶

Open holog file and return instance of the holog data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path to holog file.
Returns: Holography holog object; None if file not found.
Return type: AstrohackHologFile

AstrohackHologFile Holog object allows the user to access holog data via compound dictionary keys with values, in order of depth, ddi -> map -> ant. The holog object also provides a summary() helper function to list available keys for each file. An outline of the holog object structure is show below:

holog_mds =
    {
        ant_0:{
            ddi_0:{
                 map_0: holog_ds,
                     ⋮
                 map_n: holog_ds
            },
            ⋮
            ddi_p: …
        },
    ⋮
    ant_m: …
    }

open_image(file: str) → Union[astrohack.io.image_mds.AstrohackImageFile, None][source]¶

Open image file and return instance of the image data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path to image file.
Returns: Holography image object; None if file not found.
Return type: AstrohackImageFile

AstrohackImageFile Image object allows the user to access image data via compound dictionary keys with values, in order of depth, ant -> ddi. The image object also provides a summary() helper function to list available keys for each file. An outline of the image object structure is show below:

image_mds =
    {
        ant_0:{
            ddi_0: image_ds,
            ⋮
            ddi_m: image_ds
        },
        ⋮
        ant_n: …
    }

open_panel(file: str) → Union[astrohack.io.panel_mds.AstrohackPanelFile, None][source]¶

Open panel file and return instance of the panel data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path ot panel file.
Returns: Holography panel object; None if file not found.
Return type: AstrohackPanelFile

AstrohackPanelFile Panel object allows the user to access panel data via compound dictionary keys with values, in order of depth, ant -> ddi. The panel object also provides a summary() helper function to list available keys for each file. An outline of the panel object structure is show below:

panel_mds =
    {
        ant_0:{
            ddi_0: panel_ds,
            ⋮
            ddi_m: panel_ds
        },
        ⋮
        ant_n: …
    }

open_locit(file: str) → Union[astrohack.io.locit_mds.AstrohackLocitFile, None][source]¶

Open locit file and return instance of the locit data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path of locit file.
Returns: locit object; None if file not found.
Return type: AstrohackLocitFile

AstrohackLocitFile Locit object allows the user to access locit data via compound dictionary keys with values, in order of depth, ant -> ddi. The locit object also provides a summary() helper function to list available keys for each file. An outline of the locit object structure is show below:

locit_mds =
    {
        ant_0:{
            ddi_0: locit_ds,
            ⋮
            ddi_m: locit_ds
        },
        ⋮
        ant_n: …
    }

open_position(file: str) → Union[astrohack.io.position_mds.AstrohackPositionFile, None][source]¶

Open position file and return instance of the position data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path of position file.
Returns: position object; None if file does not exist.
Return type: AstrohackPositionFile

AstrohackPositionFile position object allows the user to access position data via compound dictionary keys with values, in order of depth, ant -> ddi. The position object also provides a summary() helper function to list available keys for each file. An outline of the position object structure is show below:

position_mds =
    {
        ant_0:{
            ddi_0: position_ds,
            ⋮
            ddi_m: position_ds
        },
        ⋮
        ant_n: …
    }

open_pointing(file: str) → Union[astrohack.io.point_mds.AstrohackPointFile, None][source]¶

Open pointing file and return instance of the pointing data object. Object includes summary function to list available dictionary keys.

Parameters: file (str) – Path to pointing file.
Returns: Holography pointing object; None if file does not exist.
Return type: AstrohackPointFile

AstrohackPointFile Pointing object allows the user to access pointing data via dictionary key with value based on ant. The pointing object also provides a summary() helper function to list available keys for each file. An outline of the pointing object structure is show below:

point_mds =
    {
        ant_0: point_ds,
        ⋮
        ant_n: point_ds
    }

astrohack.io.dio¶

Module Contents¶

Functions¶

`astrohack.io.dio`¶