simpunch.util#

Utility functions.

Functions#

`update_spacecraft_location`(→ ndcube.NDCube)	Update the spacecraft location metadata.
`write_array_to_fits`(→ None)	Write an array to a FITS file using compression.
`generate_stray_light`(...)	Generate stray light arrays for B and pB channels for WFI and NFI instruments.
`get_subdirectory`(→ str)	Determine where to put a file.
`fill_metadata_defaults`(→ None)	Add some extra default values to a NormalizedMetadata instance.

Module Contents#

simpunch.util.update_spacecraft_location(input_data: ndcube.NDCube, time_obs: astropy.time.Time) → ndcube.NDCube[source]#: Update the spacecraft location metadata.

simpunch.util.write_array_to_fits(path: str, image: numpy.ndarray, overwrite: bool = True) → None[source]#: Write an array to a FITS file using compression.

simpunch.util.generate_stray_light(shape: tuple, instrument: str = 'WFI', pstate: str = 'both') → numpy.ndarray | tuple[numpy.ndarray, numpy.ndarray][source]#

Generate stray light arrays for B and pB channels for WFI and NFI instruments.

Parameters:

shape (-)
instrument (-)
pstate (-)

Returns:

- strayarray_B (2D numpy array, intensity for B channel.)
- strayarray_pB (2D numpy array, intensity for pB channel.)

simpunch.util.get_subdirectory(cube: ndcube.NDCube) → str[source]#: Determine where to put a file.

simpunch.util.fill_metadata_defaults(meta: punchbowl.data.NormalizedMetadata) → None[source]#: Add some extra default values to a NormalizedMetadata instance.