Object
- BeMusicStatistics

```
public class BeMusicStatistics
extends Object
```
譜面統計情報を表します。
当クラスでは、譜面を一定時間ごとに分割し、その時間の範囲(「期間」または「期間統計情報」と呼称します) で譜面がどのような構成になっているかをその期間ごとに集計した情報、およびそれらの期間全体を集計した情報を保有します。その期間1個分の情報はBeMusicTimeSpanによって表され、当クラス内でそのリストを保有しています。

期間統計情報は、ある一点の時間から統計情報構築の際に指定した期間統計情報1件分の長さの集計情報を保有します。次の期間統計情報は、期間統計情報1件分の長さの半分だけ時間を進め、同様の集計情報を保有します。それを当該譜面の演奏時間全体を含むようにリスト化されます。具体的には以下の図を参照してください。
```
           +-------+
           |       |
           | 期間3 |
           | +-----+-+
 +------+  | |     | |
 |      |  | |期間2| |
 |      |  +-+-----+ |
 |      |  | |     | |
 | 楽曲 |  | |     | |
 |      |  | +-----+-+
 |      |  | 期間1 |
 |      |  |       |
 +------+  +-------+
 
```
上記のように、期間2は期間1の後半と期間3の前半を含む形で統計情報を集計します。これにより平均値などの統計情報の精度をできるだけ高められるようにすることを意図しています。当クラスからこれらの期間統計情報を個別に参照できますが、それらの情報にアクセスする際は上で述べたような意図で統計情報が集計されていることに留意してください。

どのような統計情報が集計されるかについては、各統計情報の取得メソッドに記載の解説を参照してください。また、集計される統計情報の内容はBMSライブラリの更新によって追加・更新される場合があります。
関連項目:

BeMusicStatisticsBuilder, BeMusicTimeSpan

メソッドの概要

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッド	説明
`double`	`getAverageDensity()`	平均ノート密度(Notes/sec)を取得します。
`double`	`getAverageGazePoint()`	注視点傾向の値を取得します。
`double`	`getAverageGazePointR()`	注視点傾向の値を取得します。
`double`	`getAverageGazeSwingley()`	注視点変動係数の平均値を取得します。
`double`	`getAverageGazeSwingleyR()`	注視点変動係数の平均値を取得します。
`double`	`getAverageViewSwingley()`	視野幅変動係数の平均値を取得します。
`double`	`getAverageViewSwingleyR()`	視野幅変動係数の平均値を取得します。
`double`	`getAverageViewWidth()`	平均視野幅を取得します。
`double`	`getAverageViewWidthR()`	平均視野幅を取得します。
`static String`	`getDeltaSystemVersion()`	Delta Systemのアルゴリズムバージョンを取得します。
`double`	`getMaxDensity()`	最大ノート密度(Notes/sec)を取得します。
`double`	`getNoPlayingRatio()`	無操作期間の比率を取得します。
`BeMusicNoteLayout`	`getNoteLayout()`	この統計情報の対象となったノートレイアウトを取得します。
`double`	`getNoVisualEffectRatio()`	視覚効果のない期間の比率を取得します。
`BeMusicRatingType`	`getPrimaryTendency()`	Delta Systemのレーティング値の中で最も値の大きいレーティング種別を取得します。
`int`	`getRating(BeMusicRatingType ratingType)`	Delta Systemによって算出されたレーティング値を取得します。
`String`	`getRatingAlgorithmVersion()`	Delta Systemのアルゴリズムバージョンを取得します。
`BeMusicRatingType`	`getSecondaryTendency()`	Delta Systemのレーティング値の中で2番目に値の大きいレーティング種別を取得します。
`BeMusicTimeSpan`	`getSpan(int index)`	指定された位置の期間統計情報を取得します。
`int`	`getSpanCount()`	期間統計情報の数を取得します。
`double`	`getSpanLength()`	期間統計情報1件の長さを秒単位で取得します。

クラスから継承されたメソッド Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - getSpanCount
```
public final int getSpanCount()
```
    期間統計情報の数を取得します。
    
    戻り値:
    
    期間統計情報の数
  - getSpan
```
public final BeMusicTimeSpan getSpan(int index)
```
    指定された位置の期間統計情報を取得します。
    
    パラメータ:
    
    index - インデックス
    
    戻り値:
    
    期間統計情報
    
    例外:
    
    IndexOutOfBoundsException - indexが負の値またはgetSpanCount()以上
  - getSpanLength
```
public final double getSpanLength()
```
    期間統計情報1件の長さを秒単位で取得します。
    この値はBeMusicStatisticsBuilder.setSpanLength(double)で指定した値と等価になります。
    
    戻り値:
    
    統計情報1件の長さ
  - getNoteLayout
```
public final BeMusicNoteLayout getNoteLayout()
```
    この統計情報の対象となったノートレイアウトを取得します。
    このオブジェクトが示す統計情報は、当メソッドで取得できるノートレイアウトで計算したものとなります。具体的にはBeMusicStatisticsBuilder.setNoteLayout(BeMusicNoteLayout)で指定したレイアウトと等価になります。
    
    戻り値:
    
    この統計情報の対象となったノートレイアウト
  - getAverageDensity
```
public final double getAverageDensity()
```
    平均ノート密度(Notes/sec)を取得します。
    平均ノート密度は、操作可能ノートが存在する期間の総ノート数(BeMusicTimeSpan.getNoteCount())から 1秒間のノート密度を計算した値の平均値になります。ノートの存在しない期間は平均ノート密度の計算対象外になる点に注意してください。
    
    この値は期間統計情報1件の長さの設定(BeMusicStatisticsBuilder.setSpanLength(double))により値が変動します。長さが短すぎても長すぎても精度の高い値は得られません。長さ0.5～1秒程度が最も現実的な精度が得られる目安としてください。
    
    戻り値:
    
    平均ノート密度(Notes/sec)
  - getMaxDensity
```
public final double getMaxDensity()
```
    最大ノート密度(Notes/sec)を取得します。
    最大ノート密度は、全期間のうち総ノート数(BeMusicTimeSpan.getNoteCount())が最も多い値から1秒間のノート密度を計算した値と等価になります。
    
    この値は期間統計情報1件の長さの設定(BeMusicStatisticsBuilder.setSpanLength(double))により値が変動します。長さが短すぎても長すぎても精度の高い値は得られません。長さ0.5～1秒程度が最も現実的な精度が得られる目安としてください。
    
    戻り値:
    
    最大ノート密度
  - getNoPlayingRatio
```
public final double getNoPlayingRatio()
```
    無操作期間の比率を取得します。
    値の範囲は0～1の間になります。従って、ノート数としてカウントされるノートが全く存在しない場合は1、全期間で1件以上のノート数としてカウントされるノートが存在する場合は0を示します。
    
    戻り値:
    
    無操作期間の比率
  - getNoVisualEffectRatio
```
public final double getNoVisualEffectRatio()
```
    視覚効果のない期間の比率を取得します。
    値の範囲は0～1の間になります。従って、視覚効果が全くない場合は1、全期間で何らかの視覚効果がある場合は0を示します。
    
    この値は操作可能ノートが存在しない期間(getNoPlayingRatio())と似ていますが、操作可能でない、つまりノート数としてカウントされないノートが存在する場合も視覚効果ありと認識されます。例えば、ある期間にロングノートの操作継続中(BeMusicNoteType.LONG)しか存在しない場合などがこれに該当します。
    
    戻り値:
    
    視覚効果のない期間の比率
  - getAverageGazePoint
```
public final double getAverageGazePoint()
```
    注視点傾向の値を取得します。
    当メソッドで取得できる値はスクラッチがスイッチの左側、またはダブルプレーの注視点傾向の値です。この値は視覚効果のある期間の注視点(BeMusicTimeSpan.getGazePoint())の平均値になります。全期間を通しての注視点の平均値となるため、取得できる値はあくまで当該譜面における平均的な注視点の目安と考えてください。多くの一般的な譜面では、注視点は時間の経過と共に左右に大きく振れます。
    
    戻り値:
    
    注視点傾向の値
  - getAverageGazePointR
```
public final double getAverageGazePointR()
```
    注視点傾向の値を取得します。
    当メソッドで取得できる値はスクラッチがスイッチの右側ある場合の値です。この値は視覚効果のある期間の注視点(BeMusicTimeSpan.getGazePointR())の平均値になります。全期間を通しての注視点の平均値となるため、取得できる値はあくまで当該譜面における平均的な注視点の目安と考えてください。多くの一般的な譜面では、注視点は時間の経過と共に左右に大きく振れます。
    
    戻り値:
    
    注視点傾向の値
  - getAverageViewWidth
```
public final double getAverageViewWidth()
```
    平均視野幅を取得します。
    当メソッドで取得できる値はスクラッチがスイッチの左側、またはダブルプレーの平均視野幅です。この値は視覚効果のある期間のの視野幅(BeMusicTimeSpan.getViewWidth())の平均値になります。
    
    戻り値:
    
    平均視野幅
  - getAverageViewWidthR
```
public final double getAverageViewWidthR()
```
    平均視野幅を取得します。
    当メソッドで取得できる値はスクラッチがスイッチの右側にある場合の平均視野幅です。この値は視覚効果のある期間のの視野幅(BeMusicTimeSpan.getViewWidthR())の平均値になります。
    
    戻り値:
    
    平均視野幅
  - getAverageGazeSwingley
```
public final double getAverageGazeSwingley()
```
    注視点変動係数の平均値を取得します。
    注視点変動係数とは、前後期間からの注視点の移動量を数値化した値で0～1の範囲を示します。 0は注視点が全く移動せず、1は注視点が水平方向に最大限振れることを表します。
    
    当メソッドで取得できる値はスクラッチがスイッチの左側、またはダブルプレーの注視点変動係数です。この値は視覚効果のある期間の注視点変動係数(BeMusicTimeSpan.getGazeSwingley())の平均値になります。
    
    戻り値:
    
    注視点変動係数の平均値
  - getAverageGazeSwingleyR
```
public final double getAverageGazeSwingleyR()
```
    注視点変動係数の平均値を取得します。
    注視点変動係数とは、前後期間からの注視点の移動量を数値化した値で0～1の範囲を示します。 0は注視点が全く移動せず、1は注視点が水平方向に最大限振れることを表します。
    
    当メソッドで取得できる値はスクラッチがスイッチの右側にある場合の注視点変動係数です。この値は視覚効果のある期間の注視点変動係数(BeMusicTimeSpan.getGazeSwingleyR())の平均値になります。
    
    戻り値:
    
    注視点変動係数の平均値
  - getAverageViewSwingley
```
public final double getAverageViewSwingley()
```
    視野幅変動係数の平均値を取得します。
    視野幅変動係数とは、前後期間からの視野幅の変動量を数値化した値で0～1の範囲を示します。 0は視野幅が全く変化せず、1は視野幅が最大限振れることを表します。
    
    当メソッドで取得できる値はスクラッチがスイッチの左側、またはダブルプレーの視野幅変動係数です。この値は視覚効果のある期間の視野幅変動係数(BeMusicTimeSpan.getViewSwingley())の平均値になります。
    
    戻り値:
    
    視野幅変動係数の平均値
  - getAverageViewSwingleyR
```
public final double getAverageViewSwingleyR()
```
    視野幅変動係数の平均値を取得します。
    視野幅変動係数とは、前後期間からの視野幅の変動量を数値化した値で0～1の範囲を示します。 0は視野幅が全く変化せず、1は視野幅が最大限振れることを表します。
    
    当メソッドで取得できる値はスクラッチがスイッチの右側にある場合の視野幅変動係数です。この値は視覚効果のある期間の視野幅変動係数(BeMusicTimeSpan.getViewSwingleyR())の平均値になります。
    
    戻り値:
    
    視野幅変動係数の平均値
  - getRatingAlgorithmVersion
```
public final String getRatingAlgorithmVersion()
```
    Delta Systemのアルゴリズムバージョンを取得します。
    当メソッドは、この譜面統計情報オブジェクトが保持するレーティング値を算出した段階でのDelta Systemのアルゴリズムバージョンを取得します。アルゴリズムバージョンの書式についてはgetDeltaSystemVersion() を参照してください。
    
    どのレーティング値も算出しなかった場合、当メソッドはnullを返します。譜面統計情報オブジェクトがレーティング値を算出しているかどうかが定かではない場合には必ずnullチェックを行うようにしてください。
    
    戻り値:
    
    Delta Systemのアルゴリズムバージョン
  - getRating
```
public final int getRating(BeMusicRatingType ratingType)
```
    Delta Systemによって算出されたレーティング値を取得します。
    レーティング値の算出はオプション機能です。レーティング値を算出するには BeMusicStatisticsBuilder.addRating(BeMusicRatingType...)により算出したいレーティング種別を追加して譜面統計情報の集計を行う必要があります。算出対象外のレーティング値を指定すると負の値を返します。
    
    Delta Systemのレーティング値は整数値で返されますが、実際にユーザーにプレゼンテーションする際には返されたレーティング値を100で除算し小数点第2位までを示すことを想定しています。プレゼンテーション用に文字列を生成する際はBeMusicRatingType.toString(int)を使用してください。
    
    パラメータ:
    
    ratingType - レーティング種別
    
    戻り値:
    
    Delta Systemによって算出されたレーティング値
    
    例外:
    
    NullPointerException - ratingTypeがnull
  - getPrimaryTendency
```
public final BeMusicRatingType getPrimaryTendency()
```
    Delta Systemのレーティング値の中で最も値の大きいレーティング種別を取得します。
    当メソッドが返すレーティング種別は、当該譜面の「主傾向」を表します。
    
    主傾向は、全てのレーティング値を算出対象として譜面統計情報を集計した場合に最も有効な状態となります。算出対象外となったレーティング種別が最も大きいレーティング値になる可能性があるためです。
    
    どのレーティング値も算出しなかった場合、当メソッドはnullを返します。譜面統計情報オブジェクトがレーティング値を算出しているかどうかが定かではない場合には必ずnullチェックを行うようにしてください。
    
    当メソッドが扱うレーティング種別にはBeMusicRatingType.DELTAは含まれないことに注意してください。
    
    戻り値:
    
    レーティング値が最も大きいレーティング種別
  - getSecondaryTendency
```
public final BeMusicRatingType getSecondaryTendency()
```
    Delta Systemのレーティング値の中で2番目に値の大きいレーティング種別を取得します。
    当メソッドが返すレーティング種別は、当該譜面の「副次傾向」を表します。
    
    主傾向と同様に、全てのレーティング値を算出対象として譜面統計情報を集計した場合に最も有効な状態となります。また、レーティング値を1つしか算出しなかった場合、そのレーティング値の種別を返します。つまり、副次傾向は主傾向と同じ値を示すことになります。
    
    どのレーティング値も算出しなかった場合、当メソッドはnullを返します。譜面統計情報オブジェクトがレーティング値を算出しているかどうかが定かではない場合には必ずnullチェックを行うようにしてください。
    
    当メソッドが扱うレーティング種別にはBeMusicRatingType.DELTAは含まれないことに注意してください。
    
    戻り値:
    
    レーティング値が2番目に大きいレーティング種別
  - getDeltaSystemVersion
```
public static String getDeltaSystemVersion()
```
    Delta Systemのアルゴリズムバージョンを取得します。
    Delta SystemはBMSライブラリ本体とは別のバージョンを保有しています。BMSライブラリのアップデートによって Delta Systemが必ずしも更新されるとは限らないためです。
    
    また、アルゴリズムバージョンはDelta Systemのレーティング値分析アルゴリズムがどのような状態であるかを確認するのに役立ちます。アルゴリズムバージョンの見かたについては以下を参照してください。
    
    書式
    [メジャーバージョン].[リビジョン番号]-[アルゴリズム状態][パラメータ変更状態]
    
    メジャーバージョン
    Delta Systemそのもののバージョンを表します。この値が増加すると分析アルゴリズムの内容が1から見直され、分析方法が根本的に変化することを示します。レーティング値は楽曲ごとに大幅に変動する場合があり、今までの基準が全て新しいものに更新されると考えて差し支えありません(基本的には分析結果がより良く改善されます)。
    
    リビジョン番号
    同一メジャーバージョンの分析アルゴリズムにおいて、パラメータの調整・不具合の修正・分析内容の僅かな見直しを行い、分析結果の改善を行う度に値が増加します。この値が変わると特定の特徴を有する楽曲のレーティング値のみが大幅に変動するか、全体的に僅かに変動(大抵は1～2%前後)する場合があります。分析アルゴリズムの基本的な処理内容に変更はないためレーティング値の全体的な推移が大幅に変動することはありません(リビジョン番号の更新ではそのような変更は行いません)。
    
    アルゴリズム状態
    分析アルゴリズムが現在どのような位置付けであるかを端的に表す1文字で、'D','R','F'の3種類があります。
    'D' (Draft) は分析アルゴリズムのベースは完成しているものの、重大な欠陥が潜んでいる確率が高めであることを表します。「重大な欠陥」とは具体的に、特定の特徴を有する楽曲で想定外に高い、または低いレーティング値を出力したり、低難易度の譜面で恣意的にレーティング値を吊り上げようとする悪意のある楽曲への耐性が欠落していたり等が挙げられます。分析アルゴリズムの品質が担保できていない段階では、開発者の判断により状態 'D' を付与します。
    'R' (Reviewing) は 'D' で挙げたような重大な欠陥を認知できる限り改善し、レーティング値のユーザーレビューを実施している段階であることを表します。この段階では開発者側としての調整は完了しており、ユーザーからの報告・意見等がある可能性を踏まえ、報告・意見等をレーティング値に反映する余地を残した状態となります。この状態以降はレーティング値の大幅な変動は予定されませんが、一般的な譜面には含まれないような配置が多数使用されるような個性的な譜面ではやや大きめの変動が生じる可能性があります。
    'F' (Fixed) はユーザーレビューも完了し、当該メジャーバージョンでのレーティング値が確定した状態を表します。これ以降のアップデートでは、メジャーバージョンの更新が行われない限りレーティング値が変動することはありません。ただし、Delta Systemの不具合修正等で動作改善が行われ、制作者の意図する譜面を正確に読み込めるようになると値が変動する可能性はあります。通常、そのような不具合は状態 'R' の段階までに修正されます。
    
    パラメータ変更状態
    Delta Systemは、開発者向けにソースコードを変更することなくレーティングパラメータを調整する機能が備わっています (その機能は非公開となっています)。開発者はレーティング結果の精度向上のためにレーティングパラメータを調整することがあり、調整を行った状態でレーティングを行うと、その事実が分かるようアルゴリズムの末尾に 'C' の文字を付加します。この文字が付加されたアルゴリズムバージョンで得られたレーティング値に信頼性はありません。
    
    表記例
    1.15-R
    上記の例ではアルゴリズムバージョン 1 が 15回更新され、ユーザーレビュー中であることを示します。
    
    戻り値:
    
    Delta Systemのアルゴリズムバージョン

クラス BeMusicStatistics

メソッドの概要

クラスから継承されたメソッド Object

メソッドの詳細

getSpanCount

getSpan

getSpanLength

getNoteLayout

getAverageDensity

getMaxDensity

getNoPlayingRatio

getNoVisualEffectRatio

getAverageGazePoint

getAverageGazePointR

getAverageViewWidth

getAverageViewWidthR

getAverageGazeSwingley

getAverageGazeSwingleyR

getAverageViewSwingley

getAverageViewSwingleyR

getRatingAlgorithmVersion

getRating

getPrimaryTendency

getSecondaryTendency

getDeltaSystemVersion