galactocentric_frame_defaults

class astropy.coordinates.galactocentric_frame_defaults[ソース]

ベースクラス: astropy.utils.state.ScienceState

このような制御は Galactocentric フレーム、フレームは将来のバージョンで更新される可能性がある astropy それがそうです。ご注意ください、使っています Galactocentric ここでの値を変更することは,値を渡すことで影響を与えない. Galactocentric 初期化器です。これらのデフォルト値を修正することは,フレームワークを使用する際にのみフレーム属性値に影響を与える,たとえば, Galactocentric あるいは…。 Galactocentric() 明確な論拠はありません。

このようなパラメータ設定は、以下で指定されたオプションを用いて文字列名を指定することにより制御される。

  • ‘Pre-V 4.0’:現在のデフォルト値であり、デフォルトフレーム属性値はその元(Pre-Astpy-V 4.0)値に設定されます。

  • ‘V 4.0’:Astropyバージョン4.0で更新された属性値。

  • ‘Latest’:最新のパラメータセットの別名(現在は‘v 4.0’)

あるいは、登録ユーザが定義したパラメータ設定を使用することができる register() また,あらかじめ指定されたパラメータセットと同様に使用する.少なくとも、登録は、“galcen_coord”、“galcen_Distance”、“galcen_v_sun”、“z_sun”、“roll”である一意の名前およびパラメータ辞書を有していなければならない。以下の例を参照されたい。

このクラスは、属性中のすべてのパラメータ値の参照も追跡します references 登録所の追加情報もあります予め指定されたオプションは、ユーザ定義パラメータ設定と同様の状態情報、例えば、パラメータ不確実性を追加することを含むように拡張されてもよい。

パラメータセットとメタデータを名前別に取得する第一選択方法は get_from_registry() なぜならそれは登録所の不変性を保障するからだ。

デフォルトフレームパラメータの制御 より多くの情報を得ることができます

実例.

デフォルト設定 Galactocentric フレームパラメータは、全体的に修正されることができる:

>>> from astropy.coordinates import galactocentric_frame_defaults
>>> _ = galactocentric_frame_defaults.set('v4.0') 
>>> Galactocentric() 
<Galactocentric Frame (galcen_coord=<ICRS Coordinate: (ra, dec) in deg
    (266.4051, -28.936175)>, galcen_distance=8.122 kpc, galcen_v_sun=(12.9, 245.6, 7.78) km / s, z_sun=20.8 pc, roll=0.0 deg)>
>>> _ = galactocentric_frame_defaults.set('pre-v4.0') 
>>> Galactocentric() 
<Galactocentric Frame (galcen_coord=<ICRS Coordinate: (ra, dec) in deg
    (266.4051, -28.936175)>, galcen_distance=8.3 kpc, galcen_v_sun=(11.1, 232.24, 7.25) km / s, z_sun=27.0 pc, roll=0.0 deg)>

デフォルトパラメータは、コンテキストマネージャとしてこのようなものを使用して更新されてもよい:

>>> with galactocentric_frame_defaults.set('pre-v4.0'):
...     print(Galactocentric()) 
<Galactocentric Frame (galcen_coord=<ICRS Coordinate: (ra, dec) in deg
    (266.4051, -28.936175)>, galcen_distance=8.3 kpc, galcen_v_sun=(11.1, 232.24, 7.25) km / s, z_sun=27.0 pc, roll=0.0 deg)>

同様に、デフォルトパラメータ値の変更は、明示的に指定されたフレーム属性に影響を与えない:

>>> import astropy.units as u
>>> with galactocentric_frame_defaults.set('pre-v4.0'):
...     print(Galactocentric(galcen_distance=8.0*u.kpc)) 
<Galactocentric Frame (galcen_coord=<ICRS Coordinate: (ra, dec) in deg
    (266.4051, -28.936175)>, galcen_distance=8.0 kpc, galcen_v_sun=(11.1, 232.24, 7.25) km / s, z_sun=27.0 pc, roll=0.0 deg)>

追加のパラメータセットは、例えば、Dehnen&Binney(1998)を使用した太陽運動の測定のために登録されてもよい。1-sigmaエラーのようなメタデータを追加することもできる.本例では、必須キーPARAMETERSを修正し、推奨キーREFERENCESを修正してPARAMETERSに一致させ、追加のキーERRORを追加する(任意のキーを追加することができる)。

>>> state = galactocentric_frame_defaults.get_from_registry("v4.0")
>>> state["parameters"]["galcen_v_sun"] = (10.00, 225.25, 7.17) * (u.km / u.s)
>>> state["references"]["galcen_v_sun"] = "https://ui.adsabs.harvard.edu/full/1998MNRAS.298..387D"
>>> state["error"] = {"galcen_v_sun": (0.36, 0.62, 0.38) * (u.km / u.s)}
>>> galactocentric_frame_defaults.register(name="DB1998", **state)

先の例と同様に,新しいパラメータセットを検索することができる.

>>> state = galactocentric_frame_defaults.get_from_registry("DB1998")
>>> print(state["error"]["galcen_v_sun"])  
[0.36 0.62 0.38] km / s

属性要約

parameters \

references \

方法要約

get_from_registry \(名前)

パラメータセットの文字列名が与えられた場合,銀河を中心とした太陽パラメータとメタデータを返す.

get_solar_params_from_string \(パラメータ)

バージョン v4.2 で非推奨.

register \(名前,パラメータ[, references] )

パラメータのセットを登録します。

validate \(値)

必要であれば,値を検証してネイティブタイプに変換する.

属性文書

parameters
references

方法文書

classmethod get_from_registry(name: str)[ソース]

パラメータセットの文字列名が与えられた場合,銀河を中心とした太陽パラメータとメタデータを返す.この方法は、返された状態が可変コピーであることを保証し、したがって、行われた任意の変更はレジストリ状態に影響を与えない。

返品
stateディクト!

文字列名のレジストリコピー。少なくとも含まれるべきである:

  • “パラメータ”:dict

    銀心太陽パラメータ

  • “参考資料”ディクト! [文字列、連合[文字列、列[文字列]] ]]

    “パラメータ”の引用。フィールドは、文字列または文字列列である。

賃上げをする
KeyError

レジストリに入力された文字列が無効である場合、銀河中心フレームの太陽パラメータが検索される。

classmethod get_solar_params_from_string(arg)[ソース]

バージョン v4.2 で非推奨: GET_SOLAR_PARAMS_FROM_STRINGメソッドは破棄されており、将来のバージョンで削除される可能性があります。使用 get_from_registry 代わりに。

パラメータセットの文字列名が与えられた場合,銀河を中心とした太陽パラメータを返す.

返品
parametersディクト!

レジストリの銀河を中心とした太陽パラメータのコピー

賃上げをする
KeyError

レジストリに入力された文字列が無効である場合、銀河中心フレームの太陽パラメータが検索される。

classmethod register(name: str, parameters: dict, references=None, **meta: dict)[ソース]

パラメータのセットを登録します。

パラメータ
name応力.応力

パラメータとメタデータ集合の登録名.

parametersディクト!

銀河系の中心フレームの太陽パラメータです

referencesDictまたはNone、オプション

内容に関する参考資料 parameters それがそうです。誰も空虚な判決にはならない。

**metaDICT、オプション

登録する他の任意の属性。

classmethod validate(value)[ソース]

必要であれば,値を検証してネイティブタイプに変換する.