Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ingen084/kyoshinmonitorlib
.NETから簡単に強震モニタを利用できるようにするライブラリ
https://github.com/ingen084/kyoshinmonitorlib
earthquakes kyoshin-monitor library
Last synced: 12 days ago
JSON representation
.NETから簡単に強震モニタを利用できるようにするライブラリ
- Host: GitHub
- URL: https://github.com/ingen084/kyoshinmonitorlib
- Owner: ingen084
- License: mit
- Created: 2017-03-20T12:16:45.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-02T19:09:34.000Z (11 months ago)
- Last Synced: 2024-10-11T19:47:27.147Z (28 days ago)
- Topics: earthquakes, kyoshin-monitor, library
- Language: C#
- Homepage:
- Size: 283 KB
- Stars: 30
- Watchers: 8
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# KyoshinMonitorLib
.NETから簡単に強震モニタを利用できるようにするライブラリ
主に個人用に開発したライブラリです。
強震モニタを使用したソフトを開発する際に毎回クラスや処理をコピーするのが面倒なので作成しました。
# 更新情報
## 0.4.1.0
### 変更
- 画像解析時に実際の値とずれてしまう問題を修正しました。
## 0.4.0.0
### 変更
- 画像解析周りの機能を一新しました！
- 解析アルゴリズムは [こちらの記事(JQuake)](https://qiita.com/NoneType1/items/a4d2cf932e20b56ca444) のものを使用しています。
## 過去の更新情報
- [0.3.x台](https://github.com/ingen084/KyoshinMonitorLib/blob/f635df256afc1a8b772f932818ab6276fe884202/README.md)
- [0.1.x台](https://github.com/ingen084/KyoshinMonitorLib/blob/e581e49192417d9b65a5403681b8507073c66349/README.md)
# リファレンス
バージョン:`0.4.0.0`
主要なクラスのみ解説します。詳細な解説はソースなどを参照してください。
また、気象庁震度階級や地球の緯度経度など、小学生レベルの前提知識が必要なものがあります。
## KyoshinMonitorExceptionクラス
強震モニタのAPIから情報を取得している間に、タイムアウトやレスポンスの異常などが確認された場合に発生する例外です。
### プロパティ
| 型 | 名前 | 解説 |
|---|---|---|
|`string`|Message|どのような例外が発生したか|
|`Exception`|InnerException|内部で発生した例外|
## ApiResultクラス
APIなどを呼んだ際の結果が含まれています。
### プロパティ
| 型 | 名前 | 解説 |
|---|---|---|
|`HttpStatusCode`|StatusCode|HTTPステータスコード|
|`TResult`(ジェネリック)|Data|APIの結果 リクエストに失敗した場合`null`の可能性もあります。|
## ObservationPointクラス
[KyoshinShindoPlaceEditor](https://github.com/ingen084/KyoshinShindoPlaceEditor)と互換があります。
### LoadFromMpk/Json
```c#
public static ObservationPoint[] LoadFromMpk(string path, bool usingLz4 = false);
public static ObservationPoint[] LoadFromJson(string path);
```
観測点情報をmpk/jsonから読み込みます。失敗した場合は例外がスローされます。
**lz4圧縮済みのmpkを通常のmpkとして読み込まないように注意してください。**
### LoadFromCsv
```c#
public static (ObservationPoint[] points, uint success, uint error) LoadFromCsv(string path, Encoding encoding = null);
```
観測点情報をcsvから読み込みます。失敗した場合は例外がスローされます。
### SaveToCsv/Mpk/Json
```c#
public static void SaveToCsv(string path, IEnumerable points);
public static void SaveToMpk(string path, IEnumerable points, bool useLz4 = false);
public static void SaveToJson(string path, IEnumerable points);
```
拡張メソッド版
```c#
public static void SaveToCsv(this IEnumerable points, string path);
public static void SaveToMpk(this IEnumerable points, string path, bool useLz4 = false);
public static void SaveToJson(this IEnumerable points, string path);
```
観測点情報を各形式に保存します。失敗した場合は例外がスローされます。
## Apiクラス共通
`WebApi`/`AppApi`共通で利用できます。
### プロパティ
| 型 | 名前 | 解説 |
|---|---|---|
|`TimeSpan`|Timeout|APIを呼ぶにあたってのタイムアウト時間|
## WebApiクラス
Webで見ることができる強震モニタのAPIを使用してEEWなどの画像やデータを取得するためのクラスです。
### メソッド
| 返り値の型 | 名前(引数) | 解説 |
|---|---|---|
|`Task>`|GetEewInfo(`DateTime` time)|緊急地震速報のJsonを取得します。 EewクラスはJsonをそのままパースしたものです。 |
|`Task>`|GetRealtimeImageData(`DateTime` time, `RealtimeDataType` dataType, `bool` isBehore = false)|リアルタイムな情報(リアルタイム･震度･加速度など)の画像のbyte配列を取得します。 画像解析まで行いたい場合は下記の拡張メソッドをご利用ください。|
|`Task>`|GetEstShindoImageData(`DateTime` time)|緊急地震速報の予想震度の画像のbyte配列を取得します。|
|`Task>`|GetPSWaveImageData(`DateTime` time)|緊急地震速報のP波とS波の広がりを示す円の画像のbyte配列を取得します。|
### KyoshinMonitorLib.Imagesによる拡張メソッド
| 返り値の型 | 名前(引数) | 解説 |
|---|---|---|
|`Task>>`|ParseScaleFromParameterAsync(this `WebApi` webApi, `IEnumerable` points, `DateTime` datetime, `RealtimeDataType` dataType = RealtimeDataType.Shindo, `bool` isBehole = false)|ObservationPointのコレクションを使用して新強震モニタの画像を取得し、解析します。|
他にもありますが割愛させていただきます。
#### 画像から震度を解析するにあたってのメモ
`ImageAnalysisResult.AnalysisResult` は強震モニタ上のスケール(0～1)が返されます。
解析する画像の種類に応じて `GetResultToIntensity` `GetResultToPga` `GetResultToPgv` `GetResultToPgd` を使い分けてください。
## AppApiクラス
スマートフォンアプリケーションのAPIを使用してリアルタイム震度などのデータを取得します。
**ほとんどのAPIが現在利用できません。** いつか復活を願って処理は残しておきます…。
### メソッド
| 返り値の型 | 名前(引数) | 解説 |
|---|---|---|
|`Task>`|GetLinkedRealtimeData(`DateTime` time, `RealtimeDataType` dataType, `bool` isBehore = false)|リアルタイムデータを取得します。 自動で観測点情報などと結びつけ、インスタンスを返します。|
|`Task>`|GetRealtimeData(`DateTime` time, `RealtimeDataType` dataType, `bool` isBehore = false)|リアルタイムデータを取得します。 特に理由がない限り`GetLinkedRealtimeData`を使用することを推奨します。|
|`Task>`|GetSiteList(`string` baseSerialNo)|APIから参照できる観測点情報の一覧を取得します。 特に理由がない限り`GetLinkedRealtimeData`を使用することを推奨します。|
|`Task>`|GetEewHypoInfo(`DateTime` time)|**[利用不可]** APIから緊急地震速報の情報を取得します。 **ちなみに、複数のEEWに対応してそうです…(要検証)**|
|`Task>`|GetPSWave(`DateTime` time)|**[利用不可]** 緊急地震速報から算出された揺れの広がりを取得します。 **こちらも複数のEEWに対応してそうです。**|
|`Task>`|GetEstShindo(`DateTime` time)|**[利用不可]** 緊急地震速報から算出された予想震度の5kmメッシュ情報を取得します。|
|`Task>`|GetMeshes()|**[利用不可]** メッシュ一覧を取得します。 非常に時間がかかるため、起動時などに行い、別ファイルとしてキャッシュしておくことを推奨します。|
### 重要事項
- `GetEewHypoInfo`
- `GetPSWave`
- `GetEstShindo`
**この3つのAPIはEEWが発表されていない場合は404が帰ってきます。**
## Meshクラス
5kmメッシュ情報を取り扱います。
### プロパティ
| 型 | 名前(引数) | 解説 |
|---|---|---|
|`string`|Code|メッシュのコード 詳細不明|
|`Location`|LocationLeftTop|右上(北西)の緯度経度|
|`Location`|LocationRightBottom|左下(南東)の緯度経度|
### 備考
使用方法の詳細は省略しますが、 `GetEstShindo` の返り値を見ればわかると思います。
ですが需要があれば書くかもしれません。またお知らせください。
## UrlGeneratorクラス群
UrlGeneratorは分離した上に、各種Apiクラスでラップしているため、解説は省略させていただきます。
## SecondBasedTimerクラス
FixedTimerに時刻管理機能をつけたものです。
強震モニタの取得タイマーとしてしか考慮していないので必ず1秒になります。
### 注意
時間の更新(補正)は自動でされないため、別途タイマーなどで実行してください。
### サンプル
```c#
//タイマーのインスタンスを作成(デフォルトは精度1ms↓)
var timer = new SecondBasedTimer()
{
Offset = TimeSpan.FromSeconds(2.5), //イベントの発火時間を2500ms *後ろに* ずらす。だいたいこれ前後がおすすめ。
};
//適当にイベント設定
timer.Elapsed += time =>
{
//timeに時間が入っているのでそれを使用して取得する
};
//タイマー開始 引数には現在の時刻が必要です。
timer.Start(await NtpAssistance.GetNetworkTimeWithNtp() ?? throw new Exception());
// 時刻の補正(別のタイマーとかで回すといいと思います)
//timer.UpdateTime(await NtpAssistance.GetNetworkTimeWithNtp() ?? throw new Exception());
//改行入力待ち
Console.ReadLine();
//タイマーストップ
timer.Stop();
```
## NtpAssistance
NTPから簡単に時刻取得をするクラスです。
### メソッド
| 返り値の型 | 名前(引数) | 解説 |
|---|---|---|
|`Task`|GetNetworkTimeWithNtp(`string` hostName = "ntp.nict.jp", `ushort` port = 123, `int` timeout = 100)|SNTP通信を使用してネットワーク上から時刻を取得します。 一応SNTPを実装していますが、NICT以外のNTPサーバーでの挙動は保証しません。|
|`Task`|GetNetworkTimeWithHttp(`string` url = "https://ntp-a1.nict.go.jp/cgi-bin/jst", `double` timeout = 1000)|Http通信を使用してネットワーク上から時刻を取得します。 小数のPOSIX Timeを含んだレスポンスが返されるURLであればなんでも使用できるとおもいます。|
## JmaIntensity
気象庁震度階級を示す列挙型です。震度異常などを扱うために値が増やされています。
### サンプル
```c#
JmaIntensity shindo = 1.0f.ToJmaIntensity(); //JmaIntensity.Int1
Console.WriteLine(shindo.ToShortString()); //1
Console.WriteLine(shondo.ToLongString()); //震度1
Console.WriteLine("5+".ToJmaIntensity().ToLongString()); //文字からも解析できます。 出力:震度5強
float? invalidIntensity = null;
Console.WriteLine(invalidIntensity.ToJmaIntensity()); //nullableなfloatもできます。 出力:JmaIntensity.Unknown
```