`matplotlib.sankey`#

Matplotlib を使用してサンキーダイアグラムを作成するためのモジュール。

クラス matplotlib.sankey。Sankey ( ax = None , scale = 1.0 , unit = '' , format = '%G' , gap = 0.25 , radius = 0.1 , Shoulder = 0.03 , offset = 0.15 , head_angle = 100 , margin = 0.4 , tolerance = 1e- 06 , ** kwargs ) [出典]#

拠点:object

サンキー図。

サンキーダイアグラムは、特定のタイプのフローダイアグラムであり、矢印の幅が流量に比例して表示されます。これらは通常、プロセス間のエネルギー、材料、またはコストの移動を視覚化するために使用されます。ウィキペディア (2011 年 6 月 1 日)

新しい Sankey インスタンスを作成します。

以下にリストされているオプションの引数は、すべてのサブダイアグラムに適用されるため、一貫した配置と書式設定が行われます。

複雑なサンキーダイアグラムを描画するには、 Sankeykwargs なしで呼び出してのインスタンスを作成します。

sankey = Sankey()

次に、単純な Sankey サブダイアグラムを追加します。

sankey.add() # 1
sankey.add() # 2
#...
sankey.add() # n

最後に、完全な図を作成します。

sankey.finish()

または、代わりに、これらの呼び出しをデイジーチェーン接続するだけです。

Sankey().add().add...  .add().finish()

その他のパラメータ:

斧Axes: データをプロットする軸。axeが指定されていない場合、新しい Axes が作成されます。
スケールフロート: フローのスケーリング係数。スケールは、適切なレイアウトを維持するためにパスの幅をサイズ変更します。すべてのサブダイアグラムに同じスケールが適用されます。値は、スケールと入力の合計の積が約 1.0 になるように選択する必要があります (スケールの積と出力の合計は約 -1.0 になります)。
単位文字列: 流量に関連付けられた物理単位。単位が None の場合、どの数量もラベル付けされません。
format str または callable: Python 数値フォーマット文字列またはフローにその数量 (つまり、単位が指定されている場合は単位の倍数) のラベルを付けるために使用される呼び出し可能オブジェクト。フォーマット文字列が指定されている場合、ラベルはになります。callable が与えられた場合、それは引数として呼び出されます。format % quantityquantity
ギャップフロート: 上部または下部へ/からブレークイン/ブレークアウェイするパス間のスペース。
半径フロート: 垂直パスの内側の半径。
ショルダーフロート: 出力矢印の肩のサイズ。
オフセットフロート: テキストのオフセット (矢印のくぼみまたは先端から)。
head_angle float: 矢印の頭の角度 (度単位) (および尾の角度の負の値)。
マージンフロート: Sankey アウトラインとプロットエリアの端の間の最小スペース。
公差フロート: フローの合計の大きさの許容可能な最大値。接続されたフローの合計の大きさは、許容範囲を超えることはできません。
**kwargs: 追加のキーワード引数はに渡されadd()、最初のサブダイアグラムが作成されます。

こちらもご覧ください

Sankey.add
Sankey.finish

例

(ソースコード)

../_images/sankey_basics_00_00.png — ( png ) #

../_images/sankey_basics_00_01.png — ( png ) #

../_images/sankey_basics_00_02.png — ( png ) #

追加( patchlabel = ''、フロー=なし、方向=なし、ラベル= ''、トランク長= 1.0、パス長= 0.25、事前=なし、接続= (0, 0)、回転= 0、 ** kwargs ) [ソース] #

フローが同じ階層レベルにある単純なサンキーダイアグラムを追加します。

パラメータ:

パッチラベル文字列

ダイアグラムの中央に配置されるラベル。label ( patchlabelではありません) をキーワード引数として渡して、凡例にエントリを作成できることに注意してください。

フロートのリスト

フロー値の配列。慣例により、入力は正、出力は負です。

フローは、フロー内のインデックスの順序で、ダイアグラムの上部に沿って内側から外側に配置されます。それらは、図の側面に沿って上から下に配置され、下に沿って外側から内側に配置されます。

入力と出力の合計がゼロでない場合、不一致は幹の上端と下端に沿った 3 次ベジエ曲線として表示されます。

{-1, 0, 1} の方向リスト

フローの方向のリスト (またはすべてのフローに使用される単一の方向)。有効な値は、0 (左から入力、右から出力)、1 (上から上)、または -1 (下から上) です。

ラベル(str または None) のリスト

フローのラベルのリスト (またはすべてのフローに使用される単一のラベル)。各ラベルは、None (ラベルなし) またはラベル文字列のいずれかです。エントリが (場合によっては空の) 文字列の場合、対応するフローの数量が文字列の下に表示されます。ただし、メインダイアグラムの単位が [なし] の場合、この引数の値に関係なく、数量は表示されません。

トランクレングスフロート

入力グループと出力グループのベース間の長さ (データ空間単位)。

float のパス長リスト

ブレークイン前またはブレークアウェイ後の垂直矢印の長さのリスト。単一の値が指定された場合、それは上部と下部の最初の (内側の) パスに適用され、他のすべての矢印の長さはそれに応じて調整されます。経路長は、水平方向の入力と出力には適用されません。

前の整数

このダイアグラムを接続する前のダイアグラムのインデックス。

接続(int、int)

前のダイアグラムのフローと接続する必要があるこのダイアグラムのフローをインデックス化する (prior、this) タプル。これが最初のダイアグラムであるか、前のダイアグラムがNoneである場合、connectは無視されます。

回転フロート

ダイアグラムの回転角度 (度単位)。方向引数の解釈は、それに応じて回転されます (たとえば、回転== 90 の場合、方向エントリ 1 は左へ/左から) を意味します)。このダイアグラムが既存のダイアグラムに接続されている場合 ( priorおよびconnectを使用)、回転は無視されます。

戻り値:

サンキー: 現在のSankeyインスタンス。

その他のパラメータ:

**kwargs

追加のキーワード引数はmatplotlib.patches.PathPatch 、次に示すプロパティを設定します。たとえば、 fill=Falseまたはを使用したい場合があります。label="A legend entry"

財産

説明

agg_filter

(m, n, 3) float 配列と dpi 値を取り、(m, n, 3) 配列と画像の左下隅からの 2 つのオフセットを返すフィルター関数

alpha

わからない

animated

ブール

antialiasedまたはああ

ブールまたはなし

capstyle

CapStyleまたは {'butt', 'projecting', 'round'}

clip_box

Bbox

clip_on

ブール

clip_path

パッチまたは (パス、変換) またはなし

color

色

edgecolorまたはec

色またはなし

facecolorまたはfc

色またはなし

figure

Figure

fill

ブール

gid

力

hatch

{'/'、'\'、'|'、'-'、'+'、'x'、'o'、'O'、'.'、'*'}

in_layout

ブール

joinstyle

JoinStyleまたは {'miter', 'round', 'bevel'}

label

物体

linestyleまたは ls

{'-', '--', '-.', ':', '', (オフセット, オンオフシーケンス), ...}

linewidthまたはlw

float または None

mouseover

ブール

path_effects

AbstractPathEffect

picker

None または bool または float または callable

rasterized

ブール

sketch_params

(位取り: float、長さ: float、乱数: float)

snap

ブールまたはなし

transform

Transform

url

力

visible

ブール

zorder

浮く

財産	説明
`agg_filter`	(m, n, 3) float 配列と dpi 値を取り、(m, n, 3) 配列と画像の左下隅からの 2 つのオフセットを返すフィルター関数
`alpha`	わからない
`animated`	ブール
`antialiased`またはああ	ブールまたはなし
`capstyle`	`CapStyle`または {'butt', 'projecting', 'round'}
`clip_box`	`Bbox`
`clip_on`	ブール
`clip_path`	パッチまたは (パス、変換) またはなし
`color`	色
`edgecolor`またはec	色またはなし
`facecolor`またはfc	色またはなし
`figure`	`Figure`
`fill`	ブール
`gid`	力
`hatch`	{'/'、'\'、'\|'、'-'、'+'、'x'、'o'、'O'、'.'、'*'}
`in_layout`	ブール
`joinstyle`	`JoinStyle`または {'miter', 'round', 'bevel'}
`label`	物体
`linestyle`または ls	{'-', '--', '-.', ':', '', (オフセット, オンオフシーケンス), ...}
`linewidth`またはlw	float または None
`mouseover`	ブール
`path_effects`	`AbstractPathEffect`
`picker`	None または bool または float または callable
`rasterized`	ブール
`sketch_params`	(位取り: float、長さ: float、乱数: float)
`snap`	ブールまたはなし
`transform`	`Transform`
`url`	力
`visible`	ブール
`zorder`	浮く

こちらもご覧ください

Sankey.finish

終了( ) [ソース] #

軸を調整し、Sankey サブダイアグラムに関する情報のリストを返します。

戻り値は、次のフィールドで表されるサブダイアグラムのリストです。

分野

説明

パッチ

Sankey アウトライン (のインスタンス PathPatch)

流れ

フローの値 (入力は正、出力は負)

角度

矢印の角度のリスト [deg/90] たとえば、ダイアグラムが回転していない場合、上側への入力の角度は 3 (DOWN) になり、上側からの出力の角度はの角度になります。 1アップ）。フローがスキップされた場合 (その大きさがtoleranceより小さいため)、その角度はNoneになります。

チップ

各行が [x, y] のペアであり、流路の先端 (または「くぼみ」) の位置を示す配列流れの大きさがのインスタンスの許容範囲Sankeyより小さい場合、流れはスキップされ、チップは図の中央になります。

文章

Textダイアグラムのラベルのインスタンス

テキスト

Textフローのラベルのインスタンスのリスト

分野	説明
パッチ	Sankey アウトライン (のインスタンス `PathPatch`)
流れ	フローの値 (入力は正、出力は負)
角度	矢印の角度のリスト [deg/90] たとえば、ダイアグラムが回転していない場合、上側への入力の角度は 3 (DOWN) になり、上側からの出力の角度はの角度になります。 1アップ）。フローがスキップされた場合 (その大きさがtoleranceより小さいため)、その角度はNoneになります。
チップ	各行が [x, y] のペアであり、流路の先端 (または「くぼみ」) の位置を示す配列流れの大きさがのインスタンスの許容範囲`Sankey`より小さい場合、流れはスキップされ、チップは図の中央になります。
文章	`Text`ダイアグラムのラベルのインスタンス
テキスト	`Text`フローのラベルのインスタンスのリスト

こちらもご覧ください

Sankey.add

matplotlib.sankey#

`matplotlib.sankey`#