```{eval-rst}
.. toctree::
    :hidden:
    :maxdepth: 2
    :glob:
    :caption: Documents:
    
    docs/user_guide
    docs/user_guide.ja
    docs/sample.ipynb
```

```{eval-rst}
.. toctree::
    :hidden:
    :maxdepth: 2
    :glob:
    :caption: API Reference:
    
    autodoc/package
```

# jgdtrans

Coordinate Transformer by _Gridded Correction Parameter_
which Geospatial Information Authority of Japan (GIAJ, formerly GSIJ) distributing [^1].

国土地理院が公開しているパラメータファイル（par ファイル）による座標変換（順逆変換）を提供します。

Features:

- Supports offline transformation (no web API)
- Supports both original forward and backward transformation
- Supports verified backward transformation
- Supports all [TKY2JGD], [PatchJGD], [PatchJGD(H)], [HyokoRev], [SemiDynaEXE]
  and [POS2JGD] (geonetF3 and ITRF2014)
  - For example, Tokyo Datum to JGD2000 ([EPSG:4301] to [EPSG:4612])
    and JGD2000 to JGD2011 ([EPSG:4612] to [EPSG:6668])
- Clean implementation

Example:

```python
import jgdtrans

with open('SemiDyna2023.par') as fp:
    tf = jgdtrans.load(fp, format='SemiDynaEXE')

# Geospatial Information Authority of Japan
origin = (36.10377479, 140.087855041, 2.34)

# forward transformation
result = tf.forward(*origin)
# prints Point(latitude=36.103773017086695, longitude=140.08785924333452, altitude=2.4363138578103)
print(result)

# backward transformation
point = tf.backward(*result)
# prints Point(latitude=36.10377479, longitude=140.087855041, altitude=2.34)
print(point)

# backward transformation compatible to GIAJ web app/APIs
p = tf.backward_compat(*result)
# prints Point(latitude=36.10377479000002, longitude=140.087855041, altitude=2.339999999578243)
print(p)
```

This package does not contain parameter files, the GIAJ distributes such files [^2].

このパッケージはパラメータファイルを提供しません。公式サイトよりダウンロードしてください [^2]。

We use _TKY2JGD for Windows Ver.1.3.79_ [^3] as a reference.

[TKY2JGD]: https://www.gsi.go.jp/sokuchikijun/tky2jgd.html
[PatchJGD]: https://vldb.gsi.go.jp/sokuchi/surveycalc/patchjgd/index.html
[PatchJGD(H)]: https://vldb.gsi.go.jp/sokuchi/surveycalc/patchjgd_h/index.html
[HyokoRev]: https://vldb.gsi.go.jp/sokuchi/surveycalc/hyokorev/hyokorev.html
[SemiDynaEXE]: https://vldb.gsi.go.jp/sokuchi/surveycalc/semidyna/web/index.html
[POS2JGD]: https://positions.gsi.go.jp/cdcs

[EPSG:4301]: https://epsg.io/4301
[EPSG:4612]: https://epsg.io/4612
[EPSG:6668]: https://epsg.io/6668

[^1]: Geospatial Information Authority of Japan (GIAJ, 国土地理院): <https://www.gsi.go.jp/>,
      (English) <https://www.gsi.go.jp/ENGLISH/>.
[^2]: TKY2JGD: <https://www.gsi.go.jp/sokuchikijun/tky2jgd_download.html>;
      PatchJGD, PatchJGD(H) and HyokoRev: <https://www.gsi.go.jp/sokuchikijun/sokuchikijun41012.html>;
      SemiDynaEXE: <https://www.gsi.go.jp/sokuchikijun/semidyna.html>;
      geonetF3 and ITRF2014 (POS2JGD): <https://positions.gsi.go.jp/cdcs/>.
[^3]: TKY2JGD for Windows Ver.1.3.79 (reference implementation):
      <https://www.gsi.go.jp/sokuchikijun/tky2jgd_download.html> 
      released under [国土地理院コンテンツ利用規約] which compatible to CC BY 4.0.
[^4]: Other implementation:
      Rust <https://github.com/paqira/jgdtrans-rs>,
      Java <https://github.com/paqira/jgdtrans-java>,
      JavaScript/TypeScript <https://github.com/paqira/jgdtrans-js>.

[国土地理院コンテンツ利用規約]: https://www.gsi.go.jp/kikakuchousei/kikakuchousei40182.html

## Indices and tables

* {ref}`genindex`
* {ref}`modindex`
* {ref}`search`