Gateau User Manual
Atmospheric simulation of astronomical signals
bind_utils.py File Reference

File containing utility functions for the ctypes bindings. Most of these functions are concerned with allocating memory. More...

Functions

None gateau.bind_utils.allfillCascade (dict[str, any] CascadeDict, Structure CascadeStruct)
 Allocate and fill a cascade struct. More...
 
None gateau.bind_utils.allfillInstrument (dict[str, any] InstDict, Structure InstStruct)
 Allocate and fill an instrument struct for ctypes. More...
 
None gateau.bind_utils.allfillTelescope (dict[str, any] TelDict, Structure TelStruct)
 Allocate and fill a telescope struct for ctypes. More...
 
None gateau.bind_utils.allfillAtmosphere (dict[str, any] AtmDict, Structure AtmStruct)
 Allocate and fill an atmosphere struct for ctypes. More...
 
None gateau.bind_utils.allfillSource (dict[str, any] SourceDict, Structure SourceStruct)
 Allocate and fill a source object struct for ctypes. More...
 
Structure gateau.bind_utils.arr2ArrSpec (np.ndarray arr)
 Convert a regularly spaced Numpy array to an array specification object. More...
 

Detailed Description

File containing utility functions for the ctypes bindings. Most of these functions are concerned with allocating memory.

Function Documentation

◆ allfillAtmosphere()

None gateau.bind_utils.allfillAtmosphere ( dict[str, any]  AtmDict,
Structure  AtmStruct 
)

Allocate and fill an atmosphere struct for ctypes.

Parameters
AtmDictDictionary containing atmosphere parameters.
AtmStructStruct to be filled and passed to ctypes.

◆ allfillCascade()

None gateau.bind_utils.allfillCascade ( dict[str, any]  CascadeDict,
Structure  CascadeStruct 
)

Allocate and fill a cascade struct.

Parameters
CascadeDictDictionary containing cascade efficiencies and power spectral densities.
CascadeStructStruct to be filled and passed to ctypes.

◆ allfillInstrument()

None gateau.bind_utils.allfillInstrument ( dict[str, any]  InstDict,
Structure  InstStruct 
)

Allocate and fill an instrument struct for ctypes.

Parameters
InstDictDictionary containing instrument parameters.
InstStructStruct to be filled and passed to ctypes.

◆ allfillSource()

None gateau.bind_utils.allfillSource ( dict[str, any]  SourceDict,
Structure  SourceStruct 
)

Allocate and fill a source object struct for ctypes.

Parameters
SourceDictDictionary containing source angular extents and intensity maps.
SourceStructStruct to be filled and passed to ctypes.

◆ allfillTelescope()

None gateau.bind_utils.allfillTelescope ( dict[str, any]  TelDict,
Structure  TelStruct 
)

Allocate and fill a telescope struct for ctypes.

Parameters
TelDictDictionary containing telescope parameters.
TelStructStruct to be filled and passed to ctypes.

◆ arr2ArrSpec()

Structure gateau.bind_utils.arr2ArrSpec ( np.ndarray  arr)

Convert a regularly spaced Numpy array to an array specification object.

Parameters
arrRegular Numpy array to convert.
Returns
Array specification object representing arr.