> For the complete documentation index, see [llms.txt](https://docs.geopard.tech/geopard-tutorials/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.geopard.tech/geopard-tutorials/jpn/tsu-webapuri/equation-based-analytics/catalog-of-custom-functions.md).

# カスタム関数カタログ

これらの関数は複雑なPythonコードを内包しており、高度なデータ操作や計算を容易に実装できます。

GeoPard には、方程式ベースの分析の読みやすさと機能性を高めるために設計された、豊富なカスタム関数が用意されています。これらの関数を使えば、複雑な `python` コードをカプセル化でき、高度なデータ操作や計算を簡単に実装できます。

### 方程式を入力

<figure><img src="https://docs.geopard.tech/~gitbook/image?url=https%3A%2F%2F3272281156-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FYICBELdyAXXebKAzfLOR%252Fuploads%252FdHTdBE1CN2gSJbE7Bfo0%252Fimage.png%3Falt%3Dmedia%26token%3Dd8e3544f-feca-43a6-b6a1-f1305068de88&#x26;width=768&#x26;dpr=4&#x26;quality=100&#x26;sign=508ec9e0&#x26;sv=2" alt=""><figcaption><p>方程式を入力してください</p></figcaption></figure>

GeoPard で、より直感的で保守しやすい方程式を作成するために利用できる組み込み関数の一覧は、 `geopard` パッケージに含まれています。

### fill\_gaps\_with\_k\_neighbors

```python
# input_data is a Dataset attribute layer (e.g., Yield, NDVI)
filled_layer = geopard.fill_gaps_with_k_neighbors(yield_layer, k=5)
```

この関数は、K近傍法を使用して、データセット内のデータ欠損やゼロ値を補完します。 `input_data` 変数（選択した属性を含むデータセット）と近傍の数 `k`を指定すると、欠損値をスムーズに補完し、データの連続性と整合性を確保できます。

圃場のあちこちにデータ欠損が分布し、圃場境界の特定の部分に集中していない場合に、この関数は効果的です。

### determine\_data\_similarity

```python
similarity = geopard.determine_data_similarity(yield_2023, yield_2024)
```

この関数を使うと、2つのデータセット間のピクセルごとの類似度を計算できます。変数 `data_layer_1` と `data_layer_2` は、意味のある比較を行えるよう、 **同じ測定項目** を **同じ単位** で表す必要があります。データセットに関連付けられた変数を指定すると、0～1の値を持つ類似度マップを生成でき、比較調査やパターン認識に役立ちます。 `data_layer_1` と `data_layer_2` &#x20;

### determine\_data\_similarity\_from\_normalized

```python
layer_1_norm = geopard.normalize_data(layer_1)
layer_2_norm = geopard.normalize_data(layer_2)

similarity = geopard.determine_data_similarity_from_normalized(layer_1_norm, layer_2_norm)
```

この関数を使うと、正規化された2つのデータセット間のピクセルごとの類似度を計算できます。元の `data_layer_1` と `data_layer_2` の尺度や単位が異なる場合は、正規化をおすすめします。これらのデータセットを入力として指定すると、0～1の値を持つ類似度マップが生成され、比較調査、パターン認識、空間的な整合性の分析に活用できます。

### determine\_low\_high\_similarity

```python
zones = geopard.determine_low_high_similarity(soil_ph, yield_layer)
```

この関数は、2つのデータセット間の高低の類似性を評価します。データセットに関連付けられた変数 `data_layer_1` と `data_layer_2` を入力すると、低-低、低-高、高-低、高-高などの組み合わせを示す、カテゴリ別の類似度マップが得られます。きめ細かなデータ分類に便利です。

### get\_value\_for\_zone

```python
zone_3_values = geopard.get_value_for_zone(yield_layer, zone_map, zone_id=3)
```

この関数を使うと、1つのゾーン内にあるデータセット属性の値をすべて抽出できます。 `data_layer` （属性レイヤー）を指定し、 `zones_layer` （ゾーンマップ）、および `zone_id` （ゾーン番号）を使って、そのゾーン内の収量、散布量、播種量などの値を抽出し、分析できます。

### drop\_value

```python
clean_layer = geopard.drop_value(elevation_layer, value_to_drop=0)
```

この関数を使うと、データセットの属性から特定の値を削除できます。 `data_layer` と `value_to_drop`を指定すると、結果からその値を取り除いてデータセットをクリーンアップできます。技術的には、値は `NaN`.

### normalize\_data

```python
ndvi_normalized = geopard.normalize_data(ndvi_layer)
```

この関数を使って、データセットの属性を正規化します。 `data_layer`を渡すと、データを0～1の標準範囲にスケーリングでき、異なるデータセット間での比較や統合が容易になります。

### calculate\_total\_applied\_fertilizer

```python
applications = [urea_rate, map_rate]
coefficients = [1.0, 1.0]  # 単位を維持するには1.0を使用し、製品濃度に合わせて調整します

total_applied = geopard.calculate_total_applied_fertilizer(applications, coefficients)
```

この関数を使って、面積あたりの単位（例：kg/ha、l/ha、gal/ac）で総施肥量を計算します。 `application_list` AppliedRate属性を持つデータセットと、対応する `active_ingredient_coefficient_list` （肥料製品の有効成分係数リスト）を指定すると、実際の総施肥量を単位（例：kg、l、gal）で算出できます。

### calculate\_total\_applied\_nitrogen

```python
applications = [urea_rate, uan_rate]
nitrogen_coefficients = [0.46, 0.32]  # 各製品に含まれる窒素（有効成分）の割合

N_total_applied = geopard.calculate_total_applied_nitrogen(applications, nitrogen_coefficients)
```

この関数を使って、総施用窒素量をkg/haで計算します。 `application_list` AppliedRate属性を持つデータセットと、対応する `active_ingredient_coefficient_list` （窒素製品の有効成分係数リスト）を指定すると、実際の窒素量をkg/haに換算し、農業計画や持続可能性評価に不可欠な総施用窒素量を正確に算出できます。出力は `N_total_applied` として[`geopard.calculate_nitrogen_use_efficiency`](#calculate_nitrogen_use_efficiency).

### calculate\_nitrogen\_uptake

```python
N_uptake = geopard.calculate_nitrogen_uptake(
    yield_wet_tha=yield_layer,
    moisture_pct=moisture_layer,
    protein_pct=protein_layer,
    protein_crop_correction_coefficient=6.25
)
```

この関数を使って、窒素吸収量をkg/haで算出します。 `yield_wet_tha`, `moisture_pct`, `protein_pct` 収量データセットの値、および `protein_crop_correction_coefficient` 窒素吸収量を表す連結タンパク質を用いて、作物生産における窒素利用効率を評価できます。出力は次のように使用します。 `N_uptake` （[`geopard.calculate_nitrogen_use_efficiency`](#calculate_nitrogen_use_efficiency) .

### 窒素利用効率の計算

```python
NUE_pct = geopard.calculate_nitrogen_use_efficiency(N_total_applied, N_uptake)
```

この関数を使って、窒素利用効率をパーセンテージで評価します。 [`N_total_applied`](#calculate_total_applied_nitrogen) と [`N_uptake`](#calculate_nitrogen_uptake) の変数（前の関数の出力）を入力すると、窒素施用の効果を測定でき、肥料の使用量の最適化に役立ちます。

### コストの計算

```python
rates = [seed_rate, fertilizer_rate]
prices = [1.2, 0.8]  # 各施用量レイヤーの単位あたり価格
costs = geopard.calculate_costs(rates, prices)
```

この関数を使って、施用量と価格に基づく総コストを計算します。 `application_rate_list` にはAppliedRate属性を持つデータセットを指定し、対応する `price_per_unit_list`を指定すると、さまざまな農作業にかかる費用を集計でき、予算管理や資金計画に役立ちます。出力は次のように使用します。 `costs` （[`geopard.calculate_profit`](#calculate_profit).

### 売上の計算

```python
revenue = geopard.calculate_revenue(yield_as_mass=yield_layer, yield_price_per_unit=0.25)
```

この関数を使って、収量データセットから売上を計算します。 `yield_as_mass` はYield Dataset属性に関連付けられた値で、 `yield_price_per_unit`を指定すると、作物生産による収入を見積もることができ、経済性の評価に役立ちます。出力は次のように使用します。 `costs` （[`geopard.calculate_profit`](#calculate_profit) .

### 利益の計算

```python
profit = geopard.calculate_profit(revenue, costs)
```

この関数を使って、売上からコストを差し引いて利益を求めます。 [`revenue`](#calculate_revenue) と [`costs`](#calculate_costs) の変数（前の関数の出力）を指定すると、農業経営による利益を簡単に計算でき、収益性の分析や戦略的な意思決定に役立ちます。

### 範囲内の値の設定

```python
# 10～20の値だけを残し、それ以外を0に置き換える
filtered = geopard.fill_value_for_range(layer, min_value=10, max_value=20, value_to_fill=0)
```

この関数は、 `input` 配列内の値を指定範囲に基づいてフィルタリングします。 `input` 配列に加えて、任意で `min_value` と、任意で `max_value` しきい値を設定すると、目的の範囲内にある値を抽出できます。 `value_to_fill` パラメーターを使用すると、範囲外の値を指定した値に置き換えられるため、データのフィルタリングや正規化を強化できます。

### calculate\_per\_pixel\_mae

```python
mae_layer = geopard.calculate_per_pixel_mae(predicted_yield, observed_yield)
```

この関数は、2つのデータセット間のピクセルごとの平均絶対誤差（MAE）を計算します。絶対差を空間マップとして表示します。「絶対差」とは、対応するピクセル値の差の大きさであり、どちらの値が大きいか小さいかは考慮しません。

この関数を使うと、差異が大きい区域を特定できます。

### calculate\_per\_pixel\_relative\_deviation

```python
relative_dev = geopard.calculate_per_pixel_relative_deviation(observed_yield, modeled_yield)
```

この関数は、2つのデータセット間のピクセルごとの相対偏差を計算し、その差を `dataset_1`の値に対する割合で表します。つまり、あるピクセルの値が、対応する値からどの程度ずれているかを `dataset_1` 比率で示します。

この方法は、土壌特性、作物収量、リモートセンシングデータの変動を分析する際に特に有効です。比率として大きな差がある区域をすばやく見つけるのに役立ちます。

### calculate\_difference

```python
difference = geopard.calculate_difference(yield_2024, yield_2023)
```

この関数は、一方のデータセットからもう一方を差し引き、差分マップを作成します。データセット間で値が高い区域と低い区域を示すため、経時的な傾向や変化を把握しやすくなります。

このツールは、土壌特性、作物収量、リモートセンシングデータの変動を可視化するのに特に役立ちます。追加の分析や対策が必要な区域をすばやく特定できます。

### calculate\_relative\_difference

```python
relative_diff = geopard.calculate_relative_difference(yield_2024, yield_2023)
```

この関数は、データセット間の差を `dataset_2`の値を使って正規化し、ピクセルごとの相対差を計算します。これにより、変化の大きさを `dataset_2`.

と比較して把握できます。こうした比率による比較は、スケールの異なるデータセットを扱う際に特に有用です。土壌特性、作物収量、センサー出力の相対的な変化を明らかにし、顕著な変動がある区域の特定に役立ちます。

### calculate\_normalized\_difference

```python
normalized_diff = geopard.calculate_normalized_difference(layer_1, layer_2)
```

この関数は、両方のデータセットをそれぞれの全体最大値に対してスケーリングし、ピクセルごとの正規化差分を計算します。この処理により、元の値の範囲が異なるデータセットも直接比較できるようになります。

生成されたマップは、土壌特性、作物収量、リモートセンシングデータの変動を明確に示し、重要な差異をすばやく特定して評価できるようにします。

### build\_zones\_by\_intervals

```python
# ゾーン分けの区間
intervals = [
    (4, 8),
    (8, 12),
    (12, 16)
]

# 使用例
zones = geopard.build_zones_by_intervals(
    layer, 
    intervals
)
```

この関数は、連続値のラスターレイヤーを、ユーザー定義の値の区間に基づいて離散的なゾーンに分類し、管理ゾーンマップを作成します。

各区間が1つのゾーンを定義し、各ピクセルは値が該当する範囲のゾーンに割り当てられます。どの区間にも該当しないピクセルには -1 が設定されます。

このゾーン分けは、収量マップ、土壌特性、リモートセンシング指数を、可変施用に活用できる実用的な管理ゾーンに変換する際によく使われます。

**一般的な使用例**

* 収量、NDVI、または土壌レイヤーから管理ゾーンを作成する
* 養分施用量や播種量の計算に使うゾーンマップを準備する
* 意思決定に向けて圃場を均質なゾーンに区分する

### calculate\_nutrient\_rate\_as\_active\_ingredients\_per\_zone

```python
# target_nutrient の指定方法
target_nutrient_option1 = 50 # 固定値
# または
target_nutrient_option2 = {1: 20, 2: 40} # ゾーンごとの辞書
# または
target_nutrient_option3 = np.array([[1, 1], [2, 3]], dtype=float) # 連続値のラスターレイヤー

# applied_nutrient_operations の指定方法
applied_operations = [
    5,                                      # operation1 を定数値として指定
    {1: 2, 2: 4},                           # operation2 をゾーンごとの辞書として指定
    np.array([[1, 1], [2, 3]], dtype=float) # operation3 を連続ラスター レイヤーとして指定
]

# 使用例
rates_as_active_ingredients = geopard.calculate_nutrient_rate_as_active_ingredients_per_zone(
    zone_map, 
    target_nutrient, 
    plant_available_soil_nutrient, 
    applied_nutrient_operations = applied_operations # or []
)
```

この関数は、各管理ゾーンに必要な養分施用量（有効成分量）を計算します。

計算には次の値を使用します。

* 目標養分量、
* 土壌から供給される植物利用可能な養分量、
* 過去の作業（堆肥、肥料、消化液など）ですでに施用された養分量。

施用済み養分の作業データは、定数、ゾーンごとの値、ラスター レイヤー、またはこれらを組み合わせて指定できます。すべての入力値は自動的にゾーンごとに変換・集計されます。

既定では、目標養分量から土壌供給量と施用済み養分量の合計を差し引いて、必要施用量を計算します。結果はラスター マップとして返され、各ゾーン内では養分施用量が均一になります。

### convert\_active\_ingredient\_and\_product

```python
# 有効成分量と製品量を相互変換する係数
corrected_coefficient = 1.5  # 定数係数
# または
corrected_coefficient = np.array([[np.nan, 5], [np.nan, 1]], dtype=float)  # ピクセルごとの係数

# 使用例
rates_as_products = geopard.convert_active_ingredient_and_product(
    layer, 
    corrected_coefficient
)
```

この関数は、ラスター レイヤーを次の間で変換します。 **有効成分量と製品量** 補正係数を使用して変換します。

corrected\_coefficient `corrected_coefficient` 単一の **float** （すべてのピクセルに適用）または係数の **行列** （ピクセルごとの変換）として指定できます。通常、肥料の組成や養分濃度に基づいて、計算した養分必要量（有効成分量）を実際の製品施用量に換算する場合や、その逆の変換に使用します。

変換はピクセル単位で適用され、元のレイヤーの空間構造が保たれます。

**一般的な使用例**

* 養分施用量を肥料製品の施用量に変換する
* 養分濃度に基づいて施用マップを調整する
* 農業機械用の最終施肥処方マップを作成する

### map\_value\_by\_zone

```python
# すべてのゾーンに同じ値を割り当てる
planned_yield = geopard.map_value_by_zone(
    zone_map,
    3.0
)

# または、ゾーンごとに異なる値を割り当てる
planned_yield = geopard.map_value_by_zone(
    zone_map,
    {1: 2.91, 2: 3.0, 3: 3.06}
)

# または、既存のラスターをゾーンごとに集計する
p_zone_median = geopard.map_value_by_zone(
    zone_map,
    p2o5,
    aggregation_logic="median"
)
```

この関数は、スカラー値、ゾーンごとの辞書、またはラスター レイヤーをゾーンベースのラスターに変換します。

有効な各ピクセルには、対応するゾーンに割り当てられた値が設定されます。ラスター入力の場合、各ゾーン内の値は次のいずれかを使用して集計されます。 `mean`, `median`, `min`、または `max`。これにより、ゾーン内のばらつきが実質的になくなります。

辞書に値がない場合やNoDataピクセルには、指定した `default` が割り当てられます（デフォルトはNaN）。

**一般的な使用例**

* ゾーンごとの値からピクセル単位の目標収量を作成する
* ゾーンごとの施肥推奨量を可変施肥用ラスタに変換する
* 管理ゾーン内の土壌養分のばらつきを平滑化する
* ピクセル単位のNumPy計算に向けてゾーン単位のパラメータを準備する

### calculate\_dose\_by\_nutrient\_balance

```python
# 市販肥料の施用量を計算する
ammophos_dose = geopard.calculate_dose_by_nutrient_balance(
    zone_map,
    planned_yield={1: 2.91, 2: 3.0, 3: 3.06},
    soil_nutrient=p2o5,
    removal_per_yield_unit=12.5,
    soil_use_coefficient=0.2,
    fertilizer_use_coefficient=0.4,
    correction_coefficient=1.5,
    product_nutrient_share=0.46,
    min_dose=50,
    max_dose=100
)
```

この関数は、作物による養分吸収量と土壌からの養分供給量の収支に基づき、ピクセルごとの肥料施用量を計算します。

計算では、目標収量、作物による養分吸収量、土壌中の可給態養分、土壌および肥料の利用係数、補正係数を考慮します。得られた有効成分の必要量は、必要に応じて `product_nutrient_share`.

を使って市販肥料の施用量に換算できます。目標収量にはスカラー値、辞書、またはラスタ値を指定できます。土壌養分値はピクセルごとに使用することも、ゾーン単位に集計して使用することもできます。最終的な施用量には最小・最大施用量の上限・下限を設定でき、整数に丸めることもできます。

**一般的な使用例**

* 可変施肥用のP₂O₅およびK₂O施肥マップを作成する
* 作物の目標収量に基づいて養分補給量を計算する
* 土壌からの養分供給量と肥料利用効率を考慮する
* 有効成分の必要量を市販肥料の施用量に換算する
* 農業機械で使用できる施肥マップを作成する

### estimate\_texture\_class\_based\_on\_usda

```python
usda_texture = geopard.estimate_texture_class_based_on_usda(
    sand_pct_layer,
    silt_pct_layer,
    clay_pct_layer
)
```

この関数は、砂、シルト、粘土の割合を使って、各ピクセルのUSDA土性を推定します。

粒径組成を表す、パーセント（0～100）の3つのラスタレイヤーを指定します。出力は <mark style="background-color:green;">次のようなUSDA土性クラス名です。</mark> *<mark style="background-color:green;">砂土、壌質砂土、砂壌土、壌土、シルト壌土、砂質埴壌土、埴壌土、シルト質埴壌土、シルト質埴土、またはundefined</mark>* <mark style="background-color:green;">入力が無効な場合は</mark>

### estimate\_texture\_class\_based\_on\_fao\_wrb

```python
fao_wrb_texture = geopard.estimate_texture_class_based_on_fao_wrb(
    sand_pct_layer,
    silt_pct_layer,
    clay_pct_layer
)
```

この関数は、砂、シルト、粘土の割合に基づき、各ピクセルのFAO/WRB（ISO 11277）土性クラスを推定します。

粒径組成を表す、パーセント（0～100）の3つのラスタレイヤーを指定します。出力は <mark style="background-color:green;">次のようなFAO/WRBクラスコードです。</mark> *<mark style="background-color:green;">S、LS、SL、L、SiL、Si、SCL、CL、SiCL、SC、SiC、C、HC、またはundefined</mark>* <mark style="background-color:green;">入力が無効な場合は</mark>.

### calculate\_soil\_bulk\_density

```python
bulk_density = geopard.calculate_soil_bulk_density(texture_class_layer, som_pct_layer)
```

この関数は、土性クラスと任意の土壌有機物（SOM）に基づいて、 <mark style="background-color:green;">土壌の仮比重（g/cm³）を計算します。</mark>.

この `texture_class_layer` には、次の関数が生成するクラス名またはコードを指定します： [USDA土性関数](#estimate_texture_class_based_on_usda) または [FAO/WRB土性関数](#estimate_texture_class_based_on_fao_wrb) 上記を参照してください。

もし `som_pct_layer` がパーセント値で指定されている場合、関数はSOMを使って仮比重を補正します。それ以外の場合は、USDAまたはFAO/WRBのルックアップに従い、土性クラスに対応する土壌仮比重をg/cm³で返します。


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.geopard.tech/geopard-tutorials/jpn/tsu-webapuri/equation-based-analytics/catalog-of-custom-functions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
