drs4.specs.gain module#

class drs4.specs.gain.Gain(chan: ~typing.Annotated[~drs4.specs.common.Chan | ~typing.Any, <Role.COORD: 'coord'>], usb: ~typing.Annotated[~drs4.specs.gain.GainUSB | ~typing.Any, <Role.DATA: 'data'>], lsb: ~typing.Annotated[~drs4.specs.gain.GainLSB | ~typing.Any, <Role.DATA: 'data'>])[source]#

Bases: AsDataset

Complex gains for digital sideband separation.

chan: COORD: 'coord'>]#

Channel number.

lsb: DATA: 'data'>]#

Complex gain of LSB.

spec_version: ATTR: 'attr'>] = 0#

Version of the data specification.

usb: DATA: 'data'>]#

Complex gain of USB.

drs4.specs.gain.open_gain(ms: PathLike[str] | str, /, *, format: Literal['Dataset']) → Dataset[source]#
drs4.specs.gain.open_gain(ms: PathLike[str] | str, /, *, format: Literal['DataFrame']) → DataFrame
drs4.specs.gain.open_gain(ms: PathLike[str] | str, /) → Dataset

Open gain file (DRS4 MS file) as a DataFrame or a Dataset.

Parameters:

  • ms – Path of input gain file (DRS4 MS file).

  • format – Output data format (DataFrame|Dataset).

Returns:

DataFrame or Dataset of the input gain file.