midgard.site_info

midgard.site_info.antenna

Antenna site information classes

Description: The antenna module generates a antenna object based on site information from the SINEX file or other sources.

Example for getting antenna object: from midgard.site_info import antenna antenna.Antenna.get(source="sinex", station="ales", date=datetime(2018, 10, 1))

Following steps are carried out for getting a antenna object:

1. Plugins modulen register AntennaHistory classes (e.g. 
   AntennaHistorySinex) and updates the 'sources' attribute of the 
   AntennaHistory class. 
2. The Antenna object is initialized by calling the Antenna.get function. 
3. The AntennaHistory.get function is called via the Antenna.get function.
   Here the correct AntennaHistory class is choosen by accessing the 
   registered 'sources' attribute of the AntennaHistory class.
4. The AntennaBase.get function reads the antenna information via the
   _read_history() function of the AntennaHistorySinex or other 
   calls. The antenna information is selected via a given date.

Antenna

Full name: midgard.site_info.antenna.Antenna

Signature: ()

Main antenna class for getting antenna object depending on site information source

The site information source can be e.g. a SINEX file.

Antenna.get()

Full name: midgard.site_info.antenna.get

Signature: (source:str, station:str, date:datetime.datetime) -> Union[_ForwardRef('AntennaSinex'), Any]

Get antenna object depending on given source

Args:

Returns:

Antenna object

Antenna.sources (dict)

sources = {}

AntennaBase

Full name: midgard.site_info.antenna.AntennaBase

Signature: (station:str, antenna_info:Dict[str, Any]) -> None

Antenna base class defining common attributes and methods

AntennaBase.fields (dict)

fields = {'date_installed': 'date_installed', 'date_removed': 'date_removed', 'type': 'type', 'serial_number': 'serial_number', 'radome_type': 'radome_type', 'radome_serial_number': 'radome_serial_number'}

AntennaBase.source (NoneType)

source = None

AntennaHistory

Full name: midgard.site_info.antenna.AntennaHistory

Signature: ()

AntennaHistory.date_installed()

Full name: midgard.site_info.antenna.date_installed

Signature: (source:str, station:str) -> List[datetime.datetime]

Get all antenna installation dates for an given station

Returns:

List with antenna installation site dates

AntennaHistory.date_removed()

Full name: midgard.site_info.antenna.date_removed

Signature: (source:str, station:str) -> List[datetime.datetime]

Get all antenna removing dates for an given station

Returns:

List with antenna removing site dates

AntennaHistory.get()

Full name: midgard.site_info.antenna.get

Signature: (source:str, station:str) -> Union[_ForwardRef('AntennaHistorySinex'), Any]

Get antenna history class depending on given source

Returns:

Antenna history class depending on given source

AntennaHistory.register_source()

Full name: midgard.site_info.antenna.register_source

Signature: (source_cls:Union[_ForwardRef('AntennaHistorySinex'), Any]) -> Union[_ForwardRef('AntennaHistorySinex'), Any]

Register antenna history class in source attribute

This routine is called via plugins module, which register existing antenna history classes (e.g. AntennaHistorySinex).

Args:

Returns:

Antenna history class

AntennaHistory.sources (dict)

sources = {'sinex': <class 'midgard.site_info.antenna.AntennaHistorySinex'>}

AntennaHistoryBase

Full name: midgard.site_info.antenna.AntennaHistoryBase

Signature: (station:str) -> None

Antenna history base class defining common attributes and methods

AntennaHistoryBase.get()

Full name: midgard.site_info.antenna.get

Signature: (self, date:datetime.datetime) -> Union[_ForwardRef('AntennaSinex'), Any]

Get antenna object for given date

Args:

Returns:

Antenna object for given date

AntennaHistoryBase.source (NoneType)

source = None

AntennaHistorySinex

Full name: midgard.site_info.antenna.AntennaHistorySinex

Signature: (station:str) -> None

AntennaHistorySinex.get()

Full name: midgard.site_info.antenna.get

Signature: (self, date:datetime.datetime) -> Union[_ForwardRef('AntennaSinex'), Any]

Get antenna object for given date

Args:

Returns:

Antenna object for given date

AntennaHistorySinex.source (str)

source = 'sinex'

AntennaSinex

Full name: midgard.site_info.antenna.AntennaSinex

Signature: (station:str, antenna_info:Dict[str, Any]) -> None

Antenna class handling SINEX file antenna station information

AntennaSinex.fields (dict)

fields = {'type': 'antennaTypeName', 'serial_number': 'serialNumber', 'radome_type': 'radomeType', 'radome_serial_number': 'radomeSnr'}

AntennaSinex.source (str)

source = 'sinex'