jgdtrans.types module

Provides types.

jgdtrans.types.MeshUnitType

Type of mesh unit.

alias of Literal[1, 5]

jgdtrans.types.FormatType

Type of par file’s format.

Notes

The format 'PatchJGD_HV' is for composition of PatchJGD and PatchJGD(H) par files for the same event, e.g. touhokutaiheiyouoki2011.par and touhokutaiheiyouoki2011_h.par. We note that transformation works fine with such data, and GIAJ does not distribute such file.

It should fill by zero for the parameters of remaining transformation in areas where it supports only part of the transformation as a result of composition in order to support whole area of each parameter, e.g. altitude of Chubu (中部地方) on the composition of touhokutaiheiyouoki2011.par and touhokutaiheiyouoki2011_h.par.

The composite data should be in the same format as SemiDynaEXE.

alias of Literal[‘TKY2JGD’, ‘PatchJGD’, ‘PatchJGD_H’, ‘PatchJGD_HV’, ‘HyokoRev’, ‘SemiDynaEXE’, ‘geonetF3’, ‘ITRF2014’]

class jgdtrans.types.ParameterDictType

Bases: TypedDict

Type for Transformer.to_dict() and Transformer.from_dict().

latitude: float

The latitude parameter on the point [sec].

longitude: float

The longitude parameter on the point [sec].

altitude: float

The altitude parameter on the point [m].

class jgdtrans.types.ParDataDictType

Bases: TypedDict

Return type of Transformer.to_dict().

format: Literal['TKY2JGD', 'PatchJGD', 'PatchJGD_H', 'PatchJGD_HV', 'HyokoRev', 'SemiDynaEXE', 'geonetF3', 'ITRF2014']

The format of par file.

parameter: dict[int, ParameterDictType]

The parameters.

description: str | None

The description of the parameter.

class jgdtrans.types.ParDataLikeMappingType

Bases: TypedDict

Argument type of Transformer.from_dict().

format: Required[FormatType]

The format of par file.

parameter: Required[Mapping[int | str, ParameterDictType]]

The parameters, the key must be integer-like.

description: str | None

The description of the parameter, optional.